Digi XBee Cellular 3G Global Page 1 User Manual Download

Page: 1 / 244

Digi XBee® Cellular 3G Global

Embedded Modem

User Guide

Summary of Contents for XBee Cellular 3G Global

Page 1: ...Digi XBee Cellular 3G Global Embedded Modem User Guide...

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

Page 3: ...d 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 techcomm digi com Include the document title an...

Page 4: ...ware libraries 28 Get started with Digi Remote Manager Create a Remote Manager account and add devices 29 Create a Remote Manager account 30 Add an XBee Cellular Modem to Remote Manager 30 Verify the...

Page 5: ...th MicroPython About MicroPython 60 Why use MicroPython 60 MicroPython on the XBee Cellular Modem 60 Use XCTU to enter the MicroPython environment 60 Use the MicroPython Terminal in XCTU 61 Troublesho...

Page 6: ...pply considerations 95 Add a capacitor to the RESET line 95 Heat considerations 95 Add a fan to provide active cooling 96 Custom configuration Create a new factory default 96 Set a custom configuratio...

Page 7: ...p mode 110 Cyclic sleep mode 110 Cyclic sleep with pin wake up mode 110 Airplane mode 110 The sleep timer 110 MicroPython sleep behavior 111 Serial communication Serial interface 113 Serial data 113 U...

Page 8: ...ection 131 Send a Socket Create frame 131 Receive a Socket Create response 132 Send Socket Connect 132 Receive a Socket Connect Response 132 Receive a Socket Status 133 Send HTTP Request using Socket...

Page 9: ...RE Restore Defaults 150 SD Shutdown 151 WR Write 151 Cellular commands 152 PH Phone Number 152 S ICCID 152 IM IMEI 152 II Subscriber identity 152 MN Operator 152 MV Modem Firmware Version 153 DB Cellu...

Page 10: ...Configuration 170 P1 DIO11 PWM1 Configuration 170 P2 DIO12 Configuration 171 PD Pull Direction 171 PR Pull up down Resistor Enable 172 M0 PWM0 Duty Cycle 173 I O sampling commands 174 TP Temperature 1...

Page 11: ...2 Remote Manager Device Send Keepalive 190 MO Remote Manager Options 191 D Remote Manager certificate 191 System commands 192 KL Device Location 192 KC Contact Information 192 KP Device Description 19...

Page 12: ...Condition 233 Solution 233 Other possible issues 234 Enable Virtual COM port VCP on the driver 234 Correct a macOS Java error 235 Condition 235 Solution 235 Unresponsive cellular component in Bypass m...

Page 13: ...Additional testing Part 15 Subpart B disclaimer 241 Antennas 241 FCC USA exposure notice 241 ISED Canada exposure notice 241 Labeling requirements for the host device 242 Europe CE 242 Maximum power...

Page 14: ...ollowing firmware n 113xx and above Note This manual uses the placeholder value xx in the firmware versions listed above as the manual documents the released features as of the time of its writing Dig...

Page 15: ...customers who want to remotely monitor and manage their devices To learn more or obtain the plan that is right for your needs contact us n By phone 1 877 890 4014 USA toll free or 1 952 912 3456 Inter...

Page 16: ...to the ELIZA server n Connect to the Daytime server Optional steps You can review the information in these steps for more XBee connection examples and examples of how to use MicroPython 1 Review addi...

Page 17: ...edded Modem User Guide 17 Identify the kit contents The Developer s kit includes the following One XBIB U DEV board One 12 V power supply One cellular antenna with U FL connector One USB cable One XBe...

Page 18: ...ered WARNING The development board power supply only supports 3G mode It does not support 2G mode 3 Connect the antenna to the XBee Cellular Modem by aligning the U FL connector carefully then firmly...

Page 19: ...the drivers for your operating system 2 Upgrade XCTU to the latest version This step is required Step 2 Add a device to XCTU You must add a device to XCTU before you can update the device s firmware...

Page 20: ...ith adequate cellular network reception or the XBee will not make the connection Note Check the antenna connections if the device has trouble connecting to the network In addition to the LED confirmat...

Page 21: ...et started with MicroPython Note Some carriers restrict your internet access If access is restricted running some of these examples may not be possible Check with your carrier provider to determine wh...

Page 22: ...e device is set up correctly with the SIM card installed and the antennas connected as described in Connect the hardware 2 Open XCTU and Add a device to XCTU 3 Click the Configuration working mode but...

Page 23: ...n mode to TCP communications DL Destination Address 52 43 121 77 The target IP address of the ELIZA server DE Destination Port 0x2328 The target port number of the ELIZA server To communicate with the...

Page 24: ...sole to talk to the ELIZA Therapist Bot The following screenshot provides an example of this chat with the user s text in blue Connect to the Daytime server The Daytime server reports the current Coor...

Page 25: ...m the Radio Modules list XCTU displays the current firmware settings for that device 5 To switch to TCP communication in the IP field select 1 and click the Write button 6 To enter the destination add...

Page 26: ...Write button Hexadecimal 50 is 80 in decimal 7 To switch to TCP communication in the IP field select 1 and click the Write button 8 To move into Transparent mode in the AP field select 0 and click th...

Page 27: ...the device sends the transmission to This is represented as a hexadecimal value To connect to a TCP IP address 1 Ensure that the device is set up correctly with the SIM card installed and the antenna...

Page 28: ...Write button on the toolbar Software libraries One way to communicate with the XBee device is by using a software library The libraries available for use with the XBee Cellular Modem include n XBee J...

Page 29: ...he following methods o Scheduled connection In this method you create a list of tasks that you want to perform on the device and then start the operation This is the recommended method and is the best...

Page 30: ...uctions to complete account registration You can upgrade your Developer account to a paid account at any time When you are ready to deploy multiple XBee Cellular Modems in the field upgrade your accou...

Page 31: ...es an active operation and can be monitored for status and completion Note You must upgrade your device to the latest firmware for all features to be available See Update the firmware Some typical exa...

Page 32: ...nt to run this schedule You can add more than one device 9 Click Run Now Examples The examples in the following sections assume you are using the Digi Remote Manager Schedule wizard However you should...

Page 33: ...ation completes you can click Response to view the XML for all of the settings that your XBee reports This XML structure has the same settings that you will use in the set_setting command to configure...

Page 34: ...ion about this page Example Schedule a task to update the device firmware using Remote Manager You can use a scheduled task to update the XBee Cellular firmware Since the device is configured by defau...

Page 35: ...Run Now 11 Click Device Management Operations to view information about the operation See Operations in the Digi Remote Manager User Guide for more information about this page Example Update MicroPyth...

Page 36: ...is XML file will contain a list of commands for the operation that you will schedule in Step 3 Note The RCI commands to set_settings in the task may fail to execute because of disconnects after changi...

Page 37: ...rue waitForReconnect true sci command Update MicroPython application command name Upload Files name event on_error continue on_error event sci file_system allowOffline true commands put_file path flas...

Page 38: ...alse sci command task Step 3 Upload the XML to Remote Manager In this step you will upload the file you just created updatemicropython xml to Remote Manager 1 Log into Remote Manager 2 Click Data Serv...

Page 39: ...n view address BLE cellular firmware and I O sampling status information for a XBee device in Remote Manager The device must be in the Remote Manager inventory device list and be active 1 Set up a per...

Page 40: ...erface file_system command to securely upload a file For more information see the file_system section in the Digi Remote Manager Programming Guide File Management view You can upload and manage files...

Page 41: ...y between XBee and Remote Manager may not work as expected 6 Select SM UDP Service Enabled to enable SM UDP 7 Click Save TCP connection The TCP connection between an XBee and Remote Manager is depende...

Page 42: ...nge the MO setting back to the former default value n Remote access If you only have remote access to your XBee you can change the device to maintain a persistent connection to Remote Manager To do th...

Page 43: ...uest connect SM UDP support in the Digi Remote Manager Programming Guide Configure XBee settings within Remote Manager You can configure the device settings to use features with Remote Manager For mor...

Page 44: ...set to 1 or if you have enabled the Request connect feature in Remote Manager Digi Remote Manager is enabled on the XBee by default and has a 60 second keepalive interval which can result in excessive...

Page 45: ...some additional scenarios you can use to get familiar with the XBee If you are interested in using the intelligence built into the XBee see Get started with MicroPython Get started with CoAP 46 Get st...

Page 46: ...integration with the Web while meeting specialized requirements such as multicast support very low overhead and simplicity for constrained environments source CoAP terms When describing CoAP we use t...

Page 47: ...device is set up correctly with the SIM card installed and the antennas connected as described in Connect the hardware 2 Open XCTU and click the Configuration working mode button 3 Add the XBee Cellu...

Page 48: ...Example use Python to generate a CoAP message This example illustrates how the CoAP protocol can perform GET POST PUT DELETE requests similarly to the HTTP protocol and how to do this using the XBee...

Page 49: ...e s current baud rate XCTU provides the current baud rate in the BD Baud Rate field In this example you would type 9600 8 Press Y if you want an auto generated example Press Enter to build your own Co...

Page 50: ...w python org downloads n That you install the pyserial and paho mqtt libraries to the Python environment If you use Python 2 install these libraries from the command line with pip install pyserial and...

Page 51: ...x49 byte 15 G 0x47 byte 16 I 0x49 The following table describes the fields in the packet Field name Description Protocol Name The connect packet starts with the protocol name which is MQTT The length...

Page 52: ...nd the antennas connected as described in Connect the hardware 2 Open XCTU and click the Configuration working mode button 3 Add the XBee Cellular Modem to XCTU See Add a device to XCTU 4 Select a dev...

Page 53: ...packets list 16 Click Send selected packet 17 A CONNACK packet response from the broker appears in the Console log This is a connection acknowledgment a successful response should look like this You...

Page 54: ...ent publishes its message Hello World to the broker under the topic digitest backlog test1 Any nodes devices phones computers even microcontrollers subscribed to that same topic on the same broker rec...

Page 55: ...s is how often the client pings the broker to keep the connection alive The last line starts a network daemon that runs in the background and handles data transactions and messages as well as keeping...

Page 56: ...0 0 1 17300 Address tuple for localhost Binds server socket to localhost allows client program connection svrsock bind addrtuple svrsock listen 1 Allow 1 connection def ComReaderThread This thread lis...

Page 57: ...rotocol Its functionality is not limited to MQTT Note You can easily copy and paste code from the online version of this guide Use caution with the PDF version as it may not maintain essential indenta...

Page 58: ...m s internet connection 2 Run the publish example from Example send messages publish with MQTT in a third Python instance while the publish script is running you will have three Python scripts running...

Page 59: ...ternal components Note For in depth information and more complex code examples refer to the Digi MicroPython Programming Guide About MicroPython 60 MicroPython on the XBee Cellular Modem 60 Use XCTU t...

Page 60: ...nt board XBDB or XBIB and connect it to a computer via a USB cable Note MicroPython does not work with SPI The examples in this guide assume n You have XCTU on your computer See Install and upgrade XC...

Page 61: ...baud rate and other settings are correct 3 Click OK The Open icon changes to Close indicating that the device is properly connected 4 Press Ctrl B to get the MicroPython version banner and prompt You...

Page 62: ...ial indentations import machine from machine import Pin led Pin D4 Pin OUT value 0 Makes a pin object set to output 0 One might expect 0 to mean OFF and 1 to mean ON and this is normally the case But...

Page 63: ...oPython Terminal click the green Close button 2 Click Close at the bottom of the terminal to exit the terminal 3 In XCTU s Configuration working mode change AP API Enable to another mode and click the...

Page 64: ...change this rate as it was previously set to 115200 b s 5 Click Setup and Serial Port The Tera Term Serial port setup window appears 6 In the Tera Term Serial port setup window set the parameters to t...

Page 65: ...to the system 2 Press Ctrl B to get the MicroPython version banner and prompt You can also press Enter to bring up the prompt If you do have other USB to serial devices attached 1 Before attaching the...

Page 66: ...Get started with MicroPython Use picocom in Linux Digi XBee Cellular 3G Global Embedded Modem User Guide 66 Now you can type MicroPython commands at the prompt...

Page 67: ...r information about the available update methods Digi strongly recommends that you devise a plan to update the firmware after initial deployment For more information see Create a plan for device firmw...

Page 68: ...m device firmware updates n If updates will be performed using a host processor see Use a host processor to update the modem firmware for XBee devices over UART n If updates will be performed over the...

Page 69: ...modem firmware for XBee devices over UART Update the device firmware using XCTU You can use XCTU to update the device firmware Prerequisites n Windows PC n Digi XCTU version 6 5 0 or newer You should...

Page 70: ...plete Note The update is immediately rejected and an error is returned if the device is going into sleep mode or is being shut down See Clean shutdown 9 When all changes are complete disconnect the de...

Page 71: ...rmware ebin targets device id targets data data update_firmware sci_request format device_id fw_data Post request r requests post url auth username password data data if r status_code 200 or error in...

Page 72: ...file file update_firmware sci_request format device_id firmware_path Post request r requests post url auth username password data data if r status_code 200 or error in r content decode utf 8 print fi...

Page 73: ...cal serial port to 38400 8 N 1 4 Get the hardware version of the radio module from the bootloader a Send the V command The response to that command has the following format XXXXYYYYZZAABBBBCCCCCCCCCCC...

Page 74: ...data with page size length 2 bytes for CRC16 Note CRC16 is calculated only with the bytes of the page to be sent and is initialized with 0x0000 The polynomial used for the CRC16 is 0x8005 3 After eac...

Page 75: ...and hardware specifications 76 RF characteristics 76 Networking specifications 76 Power requirements 77 Power consumption 77 Electrical specifications 77 Regulatory approvals 78 Digi XBee Cellular 3G...

Page 76: ...he RF characteristics for the device Specification Value Transmit power Up to 24 dBm Power Class 3 2G fallback up to 33 dBm Power Class 4 Receive sensitivity Up to 111 dBm Networking specifications Th...

Page 77: ...consumption The peak current was measured from multiple tested units Specification State Average current 3G mode Connected mode TX RX current Active transmit 24 dBm 3 3 V 702 mA Tx RX current Active...

Page 78: ...V V VI Input voltage range on any I O pin 0 3 VCC_ IO 0 3 V VIL Input low voltage 0 3 VCC_ IO V VIH Input high voltage 0 7 VCC_IO V VOL Voltage output low Sinking 1 mA VCC_ IO 3 3 V 0 05 VCC_ IO V VOH...

Page 79: ...e 79 Specification Value United States Contains FCC ID XPY1CGM5NNN Innovation Science and Economic Development Canada ISED Contains IC 8595A 1CGM5NNN Europe CE Yes Australia ACMA Yes RCM New Zealand R...

Page 80: ...Hardware Mechanical drawings 81 Pin signals 81 RSSI PWM 83 SIM card 83 Associate LED functionality 83 Development boards 85 Digi XBee Cellular 3G Global Embedded Modem User Guide 80...

Page 81: ...rawings The following figures show the mechanical drawings for the XBee Cellular Modem All dimensions are in inches Pin signals The pin locations are The following table shows the pin assignments for...

Page 82: ...4 SPI_MOSI Either Disabled Digital I O 4 or SPI Slave Input Line 12 CTS DIO7 Either Output Output Clear to Send Flow Control or Digital I O 7 13 ON SLEEP DIO9 Output Output Module Status Indicator or...

Page 83: ...continuously unlike other XBee products where the output is enabled for a short period of time after each received transmission If running on the XBIB development board DIO10 is connected to the RSSI...

Page 84: ...l Connection Indication for the cause of the error Note This pattern applies only to the Transparent mode Other transmission modes do not affect the Associate LED blink pattern Standard single blink 1...

Page 85: ...boards Digi XBee Cellular 3G Global Embedded Modem User Guide 85 Development boards XBIB U DEV reference This picture shows the XBee USB development board and the table that follows explains the call...

Page 86: ...prior to the USB connector to ensure that proper USB communications are not interrupted 6 LED indicator Yellow Modem sending serial UART data to host Green Modem receiving serial UART data from host R...

Page 87: ...igi XBee Cellular 3G Global Embedded Modem User Guide 87 XBIB CU TH reference This picture shows the XBee CU TH development board and the table that follows explains the callouts in the picture Note T...

Page 88: ...controls whether current measure mode is active or inactive When inactive current can freely flow to the VCC pin of the XBee When active the VCC pin of the XBee is disconnected from the 3 3 V line on...

Page 89: ...the right OFF position to disconnect USB to UART conversion chip from the XBee This allows UART lines to be individually selected to connect through the breakout connector or the USB C interface 9 Gr...

Page 90: ...ence This picture shows the XBIB C GPS module and the table that follows explains the callouts in the picture Note This GPS module is sold separately and requires an XBIB CU TH development board Note...

Page 91: ...oard laying flat with the GPS module having a clear view of the sky Interface with the XBIB C GPS module The XBee Cellular Modem can interface with the XBIB C GPS board through the 40 pin header This...

Page 92: ...o the XBIB C GPS module see Class UART Run the MicroPython GPS demo The Digi MicroPython github repository contains a GPS demo program that parses the GPS NMEA data from the UART and prints them Note...

Page 93: ...ption keep the antenna as far away from metal objects and other electronics including the XBee Cellular Modem as possible Often small antennas are desirable but come at the cost of reduced range and e...

Page 94: ...s Power supply considerations 95 Add a capacitor to the RESET line 95 Heat considerations 95 Custom configuration Create a new factory default 96 Clean shutdown 97 Digi XBee Cellular 3G Global Embedde...

Page 95: ...to decrease high frequency noise 5 Use a wide power supply trace or power plane to ensure it can handle the peak current requirements with minimal voltage drop We recommend that the power supply and t...

Page 96: ...XBee Cellular Modem does not exceed temperature specifications Add a fan to provide active cooling The XBee Cellular Modem can become hot if you use it in the maximum upload or download scenarios see...

Page 97: ...ces Performing a shutdown allows the module to unregister from the cellular network and safely store operating parameters Failure to shutdown properly has the potential to result in delays resuming ne...

Page 98: ...e sleep_now When the module has gone to sleep and the SLEEP pin pin 13 is low power may safely be removed 1 Initiate sleep Assert SLEEP_RQ 2 Wait for sleep state to be entered SLEEP pin pin 13 low 3 P...

Page 99: ...Cellular connection process Connecting 100 Data communication with remote servers TCP UDP 100 Disconnecting 100 Digi XBee Cellular 3G Global Embedded Modem User Guide 99...

Page 100: ...device receives its IP configuration and address 4 The AI Association Indication command now returns a 0 and the sockets become available Data communication with remote servers TCP UDP Once the data...

Page 101: ...Modem User Guide 101 1 Sockets are closed cleanly if possible 2 The cellular connection is shut down 3 The cellular component is powered off Note We recommend entering Airplane mode before resetting...

Page 102: ...t an operating mode 103 Transparent operating mode 104 API operating mode 104 Bypass operating mode DEPRECATED 104 Command mode 105 MicroPython mode 107 Digi XBee Cellular 3G Global Embedded Modem Use...

Page 103: ...h a logic level asynchronous serial port It uses a UART for serial communication with those devices The XBee Cellular Modem supports three operating modes Transparent operating mode API operating mode...

Page 104: ...ted and is not recommended for new designs Direct access to the cellular module is not recommended or supported on the XBee Cellular 3G Global model CAUTION Bypass operating mode is an alternative to...

Page 105: ...re interprets incoming characters as commands It allows you to modify the device s configuration using parameters you can set using AT commands When you want to read or set any parameter of the XBee C...

Page 106: ...serial console it is often a button or menu item n Asserting DIN serial break upon power up or reset enters Command mode XCTU guides you through a reset and automatically issues the break when needed...

Page 107: ...mory so that parameter modifications persist through subsequent resets Send as RE Restore Defaults to wipe settings saved using WR back to their factory defaults Note You still have to use WR to save...

Page 108: ...croPython mode Digi XBee Cellular 3G Global Embedded Modem User Guide 108 When code runs in MicroPython with AP set to a value other than 4 stdout goes to the bit bucket and there is no input to read...

Page 109: ...110 Normal mode 110 Pin sleep mode 110 Cyclic sleep mode 110 Cyclic sleep with pin wake up mode 110 Airplane mode 110 The sleep timer 110 MicroPython sleep behavior 111 Digi XBee Cellular 3G Global E...

Page 110: ...ep mode Cyclic sleep allows the device to sleep for a specific time and wake for a short time to poll If you use the D7 command to enable hardware flow control the CTS pin asserts low when the device...

Page 111: ...e XBee Cellular Modem closes any active TCP UDP connections and turns off the cellular component As a result any sockets that were opened in MicroPython prior to sleep report as no longer being connec...

Page 112: ...Serial communication Serial interface 113 Serial data 113 UART data flow 113 Serial buffers 114 CTS flow control 114 RTS flow control 114 Digi XBee Cellular 3G Global Embedded Modem User Guide 112...

Page 113: ...ignificant bit first and a stop bit high The following diagram illustrates the serial bit pattern of data passing through the device The diagram shows UART data packet 0x1F decimal number 31 as transm...

Page 114: ...llular Modem to prevent buffer overruns CTS flow control is enabled by default you can disable it with D7 DIO7 CTS When the serial receive buffer fills with the number of bytes specified by FT Flow Co...

Page 115: ...peration SPI communications 116 Full duplex operation 117 Low power operation 118 Select the SPI port 118 Force UART operation 119 Data format 119 Digi XBee Cellular 3G Global Embedded Modem User Guid...

Page 116: ...nication with the slave SPI_ATTN Attention Alerts the master that slave has data queued to send The XBee Cellular Modem asserts this pin as soon as data is available to send to the SPI master and it r...

Page 117: ...rom the master When the master is sending data to the slave and the slave has valid data to send in the middle of receiving data from the master it allows a true full duplex operation where data is va...

Page 118: ...sleep in SM1 mode Select the SPI port To force SPI mode hold DOUT DIO13 pin 2 low while resetting the device until SPI_ATTN asserts This causes the device to disable the UART and go straight into SPI...

Page 119: ...and no SPI master is available to access the SPI slave port you can recover the device to UART operation by holding DIN CONFIG low at reset time DIN CONFIG forces a default configuration on the UART a...

Page 120: ...tion about using MicroPython on the XBee Cellular Modem refer to the Digi MicroPython Programming Guide Overview of the file system 121 XCTU interface 122 Encrypt files 122 Digi XBee Cellular 3G Globa...

Page 121: ...it is interpreted as follows n Paths starting with a forward slash are absolute and must start with flash to be valid n All other paths are relative to the current working directory n The directory re...

Page 122: ...le it is stored on the XBee Cellular Modem 2 Protection for user s MicroPython applications Use ATFS XPUT filename to place encrypted files on the file system The XPUT operation is otherwise identical...

Page 123: ...he XBee Cellular Modem ignores the most significant bit of each octet in an SMS transmission payload The device converts incoming SMS messages to ASCII Characters that cannot be represented in ASCII a...

Page 124: ...mode behavior for outgoing UDP data 126 API mode behavior for incoming TCP connections 127 API mode behavior for incoming UDP data 127 Transparent mode behavior for outgoing TCP and TLS connections 1...

Page 125: ...iple smaller API frames Using a single large API frame allows the XBee to transmit the data using fewer operations than transmitting multiple pieces of data in sequence which improves overall throughp...

Page 126: ...0 and enter the received address and port as the destination address and port along with the listening C0 local source port API mode behavior for outgoing TCP and TLS connections To initiate an outgoi...

Page 127: ...t with the CLOSE flag set API mode behavior for incoming TCP connections For incoming connections and data in API mode the XBee Cellular Modem uses the C0 Source Port and IP IP Protocol settings to sp...

Page 128: ...ttempt failed Any data received over the connection is sent out the XBee Cellular Modem s serial port A connection is closed when n The remote end closes the connection n No data has been sent or rece...

Page 129: ...data sent from a remote host to the XBee Cellular Modem s network port specified by C0 Source Port is sent out the XBee Cellular Modem s serial port Any data sent to the XBee Cellular Modem s serial...

Page 130: ...te step In addition for diagnostic purposes you can use the Socket Info SI AT command to retrieve information regarding all open sockets currently active in the system This can be queried during devel...

Page 131: ...sponse 0xC6 Socket New IPv4 Client 0xCC Socket Receive 0xCD Socket Receive From IPv4 0xCE Socket Status 0xCF Extended Socket example Single HTTP Connection This example demonstrates a complete request...

Page 132: ...erform DNS look up during the connection process Note To adapt this example for TLS use destination port 0x01 0xbb decimal 443 Be aware that many HTTPS servers use SNI Server Name Identification which...

Page 133: ...status after the socket has connected Field Value Frame type 0xCF Socket Status Socket ID 0x00 Status 0x00 Connected Socket Status received from XBee with connected status 7E 00 03 CF 00 00 30 Send HT...

Page 134: ...ve one or more Receive Data frames The server will respond with an interesting fact about a number The following information is a sample response Multiple frames may be needed to contain the full resp...

Page 135: ...0D 0A 58 2D 4E 75 6D 62 65 72 73 2D 41 50 49 2D 54 79 70 65 3A 20 74 72 69 76 69 61 0D 0A 50 72 61 67 6D 61 3A 20 6E 6F 2D 63 61 63 68 65 0D 0A 43 61 63 68 65 2D 43 6F 6E 74 72 6F 6C 3A 20 6E 6F 2D 63...

Page 136: ...bind listen operation is necessary prior to transmit in order to assign a known source address to all data sent from this socket Field Value Frame type 0x46 Socket Bind Listen Frame ID 0x01 Socket ID...

Page 137: ...ion Port 0x27 0x11 decimal 10001 Transmit Options 0x00 Payload echo this Socket SendTo frame data 7E 00 13 45 01 00 34 2B 79 4D 27 11 00 65 63 68 6F 20 74 68 69 73 E5 Receive TX Status Extended socket...

Page 138: ...a server at 54 43 121 77 port 10002 which will reply with the time when it receives a packet Field Value Frame type 0x45 Socket SendTo Frame ID 0x01 Socket ID 0x00 Destination Address 0x34 0x2B 0x79...

Page 139: ...E CE 00 00 34 2B 79 4D 27 12 00 32 30 31 39 2D 30 37 2D 31 38 20 31 38 3A 35 32 3A 34 33 0A 08 Close the socket When the socket is no longer needed it should be closed to return resources to the syste...

Page 140: ...r Send a Socket Create frame Note The XBee Cellular does not support incoming TLS sockets Field Value Frame type 0x40 Socket Create Frame ID 0x01 Protocol 0x01 TCP Socket Create frame data 7E 00 03 40...

Page 141: ...rame ID 0x01 Socket ID 0x00 Status 0x00 Success Socket Bind Listen frame received from XBee 7E 00 04 C6 01 00 00 38 Making a connection to the listener socket The IP of the XBee can be acquired throug...

Page 142: ...socket After the connection is established data received from the new socket is contained in a Socket Receive frame just like any other TCP socket Field Value Frame type 0xCD Socket Status Frame ID 0x...

Page 143: ...Listener Digi XBee Cellular 3G Global Embedded Modem User Guide 143 When a Socket Status indicating a connection close is received the socket ID will have been de allocated by the XBee and no further...

Page 144: ...pecifying TLS keys and certificates 145 Transparent mode and TLS 146 API mode and TLS 146 Key formats 146 Certificate formats 146 Certificate limitations 146 Cipher suites 146 Server Name Indication S...

Page 145: ...nt_cert is provided and match the certificate or client authentication will fail The default value is This default value preserves the legacy behavior by allowing the creation of encrypted connections...

Page 146: ...icate limitations The XBee Cellular Modem only supports certificate files that contain a single certificate in them The implications of this are n For client certificate files for example when client...

Page 147: ...necessary certificate if server authentication is needed Step 1 Get the certificate 1 Navigate to the Firmware Updates section of the Digi XBee Cellular 3G support page 2 Click Remote Manager TLS Pub...

Page 148: ...and Make sure that you do not clear bit 1 2 After a short wait you should be able to see the device as connected in Remote Manager a Log in to Remote Manager b Click Device Management c Locate the dev...

Page 149: ...s 166 I O sampling commands 174 Sleep commands 176 Command mode options 177 MicroPython commands 179 Firmware version information commands 181 Diagnostic interface commands 183 Execution commands 186...

Page 150: ...ed or you issue the CN Exit AT Command Mode or AC commands Parameter range N A Default N A FR Force Reset Resets the device The device responds immediately with an OK and performs a reset 100 ms later...

Page 151: ...u issue the SD command and a response has been returned either OK or ERROR issue the AI command If the shutdown was successful 2D is returned Parameter range Parameter Description 0 Shuts down the dev...

Page 152: ...by the cellular carrier via the SIM card S ICCID Reads the Integrated Circuit Card Identifier ICCID of the inserted SIM Parameter range N A Default Set by the SIM card IM IMEI Reads the device s Inte...

Page 153: ...t when read Parameter range Parameter Description 0 Returns the most recent cached RSSI signal value received 1 Returns a fresh uncached RSSI signal value Returned values 0x71 0x33 113 dBm to 51 dBm r...

Page 154: ...ters Default AM Airplane Mode When set the cellular component of the XBee Cellular Modem is fully turned off and no access to the cellular network is performed or possible Parameter range 0 1 0 Normal...

Page 155: ...the cellular network This command is write only Parameter range 1 to 30 ASCII characters A value of a single space character ASCII 0x20 acts as an empty value Default 0x20 A single ASCII space that in...

Page 156: ...n Sets the TLS protocol version used for the TLS socket If you change the TL value it does not affect any currently open sockets The value only applies to subsequently opened sockets Note Due to known...

Page 157: ...ofile 0x23 transmissions with profile set to 2 Format server_cert client_cert client_key Parameter range From 1 through 127 ASCII characters Default N A TM IP Client Connection Timeout The IP client c...

Page 158: ...abled if you are operating the device in Europe and the device takes a long time to reach AI 0x00 or never reaches AI 0x00 Support for disabling AT T configuration was added in firmware version 11315...

Page 159: ...159 2G Fallback mode 3 8 V Average current Peak current GSM connected mode max TX power 1 TX 1 RX slot 220 mA 2 6 A GPRS connected mode max TX power 4 TX 1 RX slot 700 mA 2 6 A EDGE connected mode ma...

Page 160: ...obile network In API mode the address is represented as the binary four byte big endian numeric value representing the IPv4 address In Transparent or Command mode the address is represented as a dotte...

Page 161: ...s to an IP address the value must be a dotted quad for example XXX XXX XXX XXX To set the destination address to a domain name the value must be a legal Internet host name for example remotemanager di...

Page 162: ...UDP when using Transparent mode or API mode with implicit sockets As long as a network connection is established to this port for TCP data received on the serial port is transmitted on the establishe...

Page 163: ...de or you issue AC Apply Changes The baud rate resets to default unless you save it with WR Write or by clicking the Write module settings button in XCTU Parameter range Standard baud rates 0x1 0xA No...

Page 164: ...e for the selected protocol is received in the UART receive buffer Set RO to 0 to transmit characters as they arrive instead of buffering them into one RF packet Parameter range 0 0xFF x character tim...

Page 165: ...he device can format the RF packets it receives into API frames and send them out the UART When API is enabled the UART data must be formatted as API frames because Transparent mode is disabled See Mo...

Page 166: ...IO0 AD0 configuration pin 20 Parameter range 0 2 5 Parameter Description 0 Disabled 1 N A 2 Analog input 3 Digital input 4 Digital output default low 5 Digital output default high Default 0 D1 DIO1 AD...

Page 167: ...K 2 Analog input 3 Digital input 4 Digital output default low 5 Digital output default high Default 0 D3 DIO3 AD3 Sets or displays the DIO3 AD3 configuration pin 17 Parameter range 0 5 Parameter Descr...

Page 168: ...igh Default 0 D5 DIO5 ASSOCIATED_INDICATOR Sets or displays the DIO5 ASSOCIATED_INDICATOR configuration pin 15 Parameter range 0 1 3 5 Parameter Description 0 Disabled 1 Associated LED 2 N A 3 Digital...

Page 169: ...the DIO7 CTS configuration pin 12 Parameter range 0 1 3 5 Parameter Description 0 Disabled 1 CTS flow control 2 N A 3 Digital input 4 Digital output default low 5 Digital output default high Default 0...

Page 170: ...ault low 5 Digital output default high Default 1 P0 DIO10 PWM0 Configuration Sets or displays the PWM DIO10 configuration pin 6 This command enables the option of translating incoming data to a PWM so...

Page 171: ...tal output default low 5 Digital output default high 6 I2C SDA Default 0 P2 DIO12 Configuration Sets or displays the DIO12 configuration pin 4 Parameter range 0 1 3 5 Parameter Description 0 Disabled...

Page 172: ...d pins Use the PD command to specify whether the resistor is pull up or pull down n If you set a PR bit to 1 it enables the pull up down resistor n If you set a PR bit to 0 it specifies no internal pu...

Page 173: ...alue of 0x200 is a 50 duty cycle Before setting the line as an output 1 Enable PWM0 output P0 DIO10 PWM0 Configuration 2 2 Apply the settings use CN Exit Command mode or AC Apply Changes The PWM perio...

Page 174: ...al notation The interpretation of the lines is n Number of samples For legacy reasons this field always returns 1 n Digital channel mask A bit mask of all I O capable pins in the system The bits set t...

Page 175: ...AT commands I O sampling commands Digi XBee Cellular 3G Global Embedded Modem User Guide 175 Field Size Analog chanel mask 1 byte Samples 2 bytes each Parameter range N A Default N A...

Page 176: ...ep 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 t...

Page 177: ...Command mode Parameter range Recommended 0x20 0x7F ASCII Default 0x2B the ASCII plus character CT Command Mode Timeout Sets or displays the Command mode timeout parameter If a device does not receive...

Page 178: ...AT commands Command mode options Digi XBee Cellular 3G Global Embedded Modem User Guide 178 Default 0x3E8 one second...

Page 179: ...le function in the MicroPython REPL refer to the Digi MicroPython Programming Guide The PYB sub command reports details of the bundled code In Command mode it returns two lines of text for example byt...

Page 180: ...Embedded Modem User Guide 180 PY Interrupt Program Sends KeyboardInterrupt to MicroPython This is useful if there is a runaway MicroPython program and you have filled the stdin buffer You can enter Co...

Page 181: ...nge N A Default Set in firmware HV Hardware Version Display the hardware version number of the device Read the device s hardware version Use this command to distinguish between different hardware plat...

Page 182: ...ge 0x25 Cellular network registration denied 0x2A Airplane mode 0x2D Modem shut down See SD Shutdown 0x2F Bypass mode active 0xFF Initializing Parameter range 0 0xFF read only Default N A HS Hardware...

Page 183: ...Default N A CI Protocol Connection Indication Displays information regarding the last IP connection when using Transparent mode AP 0 and when IP 0 1 or 4 or when IP 2 for an SMS transmission The valu...

Page 184: ...No known status The following table provides the parameter s meaning when IP 1 or 4 for TCP connections Parameter Description 0x00 The socket is open 0x01 Tried to send but could not 0x02 Invalid par...

Page 185: ...IP 2 for SMS connections Parameter Description 0x00 SMS successfully sent 0x01 SMS failed to send 0x02 Invalid SMS parameters check P Destination Phone Number 0x03 SMS not supported 0x10 No network r...

Page 186: ...e XBee Cellular Modem tears down any TCP UDP sockets and resets Internet connectivity The XBee Cellular Modem responds immediately with an OK on the UART and then causes a network restart You can also...

Page 187: ...start with a capital E followed by one or more uppercase letters and digits a space and an description of the error If writing your own AT command parsing code you can determine if an FS command resp...

Page 188: ...e test txt SHA256 n On Mac and Linux use shasum b a 256 test txt ATFS GET filename Starts a YMODEM send of filename on the XBee device When it is ready to send the XBee Cellular Modem sends a prompt S...

Page 189: ...900096 total ATFS FORMAT confirm Reformats the file system leaving it with a default directory structure Pass the word confirm as the first parameter to confirm the format The XBee Cellular Modem resp...

Page 190: ...erval value in seconds The XBee device considers a Remote Manager connection to have failed after 3 missed keepalives This command works with the K2 command to limit data usage See Configure Remote Ma...

Page 191: ...ager keepalive interval which may otherwise result in excessive data usage See Configure Remote Manager keepalive interval Parameter range 0 7 Bit Description 0 Maintains a persistent TCP connection t...

Page 192: ...ed physical location for the XBee displayed in Remote Manager Range Up to 20 ASCII characters Default One ASCII space character 0x20 KC Contact Information Sets or displays user defined contact inform...

Page 193: ...the socket ID for non Extended API Sockets which are sockets created implicitly when using IPv4 TX API frames In the example below the 0x00 socket is an IPv4 TX RX socket and the 0x01 and 0x02 socket...

Page 194: ...ECTED n LISTENING n BOUND n CLOSING PROTOCOL The protocol of the socket n UDP n TCP n TLS LOCAL_PORT The local port of the socket This is 0 unless the socket is explicitly bound to a port REMOTE_PORT...

Page 195: ...Operate in API mode API mode overview 196 Use the AP command to set the operation mode 196 API frame format 196 Digi XBee Cellular 3G Global Embedded Modem User Guide 195...

Page 196: ...to filter out additional API frames with unknown frame types into your software interface Use the AP command to set the operation mode Use AP API Enable to specify the operation mode AP command settin...

Page 197: ...For more information on using this API mode see the Escaped Characters and API Mode 2 in the Digi Knowledge base API escaped operating mode works similarly to API mode The only difference is that when...

Page 198: ...e the same as the non escaped frame Start delimiter Length Frame type Frame Data Checksum Data 7E 00 0F 17 01 00 7D 33 A2 00 40 AD 14 2E FF FE 02 4E 49 6D The length field has a two byte value that sp...

Page 199: ...th bytes 01 API identifier 01 API frame ID 50 01 Destination address low 00 Option byte 48 65 6C 6C 6F Data packet B8 Checksum To calculate the check sum you add all bytes of the packet excluding the...

Page 200: ...214 User Data Relay Output 0xAD 215 Socket Create 0x40 216 Socket Create Response 0xC0 217 Socket Option Request 0x41 218 Socket Option Response 0xC1 219 Socket Connect 0x42 220 Socket Connect Respon...

Page 201: ...contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0x08 Byte Frame ID Byte Identifies the data frame for the host to corr...

Page 202: ...s register queries immediately and not does not queue them The response for this command is also an AT Command Response frame 0x88 Format The following table provides the contents of the frame For det...

Page 203: ...ited States Format The following table provides the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0x1F Byte Frame ID...

Page 204: ...ion port 16 bit big endian Source port 16 bit big endian If the source port is 0 the device attempts to send the frame data using an existing open socket with a destination that matches the destinatio...

Page 205: ...nsmit TX Request IPv4 0x20 Digi XBee Cellular 3G Global Embedded Modem User Guide 205 Field name Field value Data type Description Payload Variable Data to be transferred to the destination may be up...

Page 206: ...ian Source port 16 bit big endian If the source port is 0 the device attempts to send the frame data using an existing open socket with a destination that matches the destination address and destinati...

Page 207: ...equest with TLS Profile 0x23 Digi XBee Cellular 3G Global Embedded Modem User Guide 207 Field name Field value Data type Description Payload Variable Data to be transferred to the destination may be u...

Page 208: ...r details on frame structure see API frame format Field name Field value Data type Description Frame type 0x88 Byte Frame ID Byte Identifies the data frame for the host to correlate with a subsequent...

Page 209: ...mit frame Status Byte Status code see the table below The following table shows the status codes Code Description 0x0 Successful transmit 0x21 Failure to transmit to cell network 0x22 Not registered t...

Page 210: ...ion 0x7E A modem update is in progress Try again after the update is complete 0x80 Connection refused 0x81 Socket connection lost 0x82 No server 0x83 Socket closed 0x84 Unknown server 0x85 Unknown err...

Page 211: ...s the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0x8A Byte Status Byte 0 Hardware reset or power up 1 Watchdog ti...

Page 212: ...frame when it receives an SMS message Format The following table provides the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Fr...

Page 213: ...ils on frame structure see API frame format Frame data fields Offset Description Frame type 3 0xB0 IPv4 32 bit source address MSB 4 The address in the example below is for a source address of 192 168...

Page 214: ...atus frames type 0x89 sent for errors A value of 0 disables the TX Status frame Destination interface Byte 0 Serial port SPI or UART when in API mode 2 MicroPython Data Variable Error cases The Frame...

Page 215: ...put on The frame can be sent or received from any of the following interfaces MicroPython internal interface or UART This frame is used in conjunction with User Data Relay 0x2D Format The following ta...

Page 216: ...rotocols TCP UDP or TLS Format The following table provides the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0x40 B...

Page 217: ...the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0xC0 Byte Frame ID Byte A reference identifier used to match stat...

Page 218: ...he frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0x41 Byte Frame ID Byte A reference identifier used to match status responses Reque...

Page 219: ...ucture see API frame format Field name Field value Data type Description Frame type 0xC1 Byte Frame ID Byte Identifier provided in request Socket ID Byte The socket ID for which modification was reque...

Page 220: ...s successful Format The following table provides the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0x42 Byte Frame I...

Page 221: ...frame structure see API frame format Field name Field value Data type Description Frame type 0xC2 Byte Frame ID Byte A reference identifier used to match status responses Socket ID Byte ID of the sock...

Page 222: ...ts Format The following table provides the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0x43 Byte Frame ID Byte A r...

Page 223: ...ed for a socket that exists the status can be only one of two values Success or Bad socket ID Format The following table provides the contents of the frame For details on frame structure see API frame...

Page 224: ...sponds with a Transmit TX Status 0x89 frame with an error To send data from a UDP socket that is not connect use a Socket SendTo 0x45 frame Format The following table provides the contents of the fram...

Page 225: ...u must perform a Socket Bind Listen 0x46 frame for a UDP connection before you attempt a SendTo in order to assign a source port Format The following table provides the contents of the frame For detai...

Page 226: ...remote address information For a UDP socket this frame binds the socket to a given port A bound UDP socket can receive data with a Socket Receive From IPv4 0xCE frame Format The following table provi...

Page 227: ...of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0xC6 Byte Frame ID Byte Resource identifier used to match status responses Sock...

Page 228: ...listener s socket ID and a new socket ID of the incoming connection along with the connection s remote address information Format The following table provides the contents of the frame For details on...

Page 229: ...llowing table provides the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description Frame type 0xCD Byte Frame ID Byte Optional This field...

Page 230: ...addressing information about the source Format The following table provides the contents of the frame For details on frame structure see API frame format Field name Field value Data type Description...

Page 231: ...on frame structure see API frame format Field name Size Description Frame type 1 Socket Status frame type 0xCF Socket ID 1 Socket ID for status reported Status 1 0x00 Connected All values other than...

Page 232: ...Cannot find the serial port for the device 233 Correct a macOS Java error 235 Unresponsive cellular component in Bypass mode 236 Not on expected network after APN change 237 Syntax error at line 1 237...

Page 233: ...to does not appear Solution 1 Click the Discover radio modules button 2 Select all of the ports to be scanned 3 Click Next and then Finish A dialog notifies you of the devices discovered and their de...

Page 234: ...USB from the XBIB U DEV board and reconnect it 4 If you have a driver installed and updated but still have issues on Windows 10 you may have to enable VCP on the driver see Enable Virtual COM port VC...

Page 235: ...u may encounter a Java error Condition When opening XCTU for the first time on a macOS computer you may see the following error Solution 1 Click More info to open a browser window 2 Click Download to...

Page 236: ...ular component if it becomes unresponsive Condition In Bypass mode the XBee Cellular Modem does not respond to commands Solution 1 Query the AI Association Indication parameter to determine whether th...

Page 237: ...entally type a character at the beginning of line 1 before pasting the code Error Failed to send SMS In MicroPython you consistently get Error Failed to send SMS messages Solution Your device cannot c...

Page 238: ...39 FCC notices 239 FCC Class B digital device notice 239 FCC publication 996369 related information 240 Antennas 241 Labeling requirements for the host device 242 Europe CE 242 ACMA Australia 244 RSM...

Page 239: ...RTANT The RF module has been certified for remote and base radio applications If the module will be used for portable applications the device must undergo SAR testing This equipment has been tested an...

Page 240: ...This module conforms to FCC Parts 22 and 24 cellular 2 3 Summarize the specific operational use conditions Certain approved antennas require attenuation for operation For the XBee Cellular Modem see A...

Page 241: ...m the end product s compliance See FCC notices Antennas FCC USA exposure notice This equipment complies with FCC radiation exposure limits prescribed for an uncontrolled environment for fixed and mobi...

Page 242: ...the words Contains transmitter module or the word Contains or similar wording expressing the same meaning as follows Contains FCC ID XPY1CGM5NNN Contains IC 8595A 1CGM5NNN L appareil h te doit tre ti...

Page 243: ...lar band 19 800 MHz UL 830 to 845 MHz DL 875 to 890 MHz 2 W 33 dBm OEM labeling requirements The CE marking must be affixed to a visible location on the OEM product The following figure shows CE label...

Page 244: ...company must comply with a or b below a Have a company presence in Australia b Have a company distributor agent in Australia that will sponsor the import of the end product Contact Digi for questions...

Search results

Summary of Contents for XBee Cellular 3G Global

Reviews:

Related manuals for XBee Cellular 3G Global

Brands by name

Popular brands

Digi XBee Cellular 3G Global, User Manual

Search results

Summary of Contents for XBee Cellular 3G Global

Reviews:

Related manuals for XBee Cellular 3G Global

Brands by name

Popular brands