Digi XBee Cellular 3G Global User Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Modem
  5. XBee Cellular 3G Global
  6. User manual

Digi XBee Cellular 3G Global User Manual

Embedded modem
Hide thumbs Also See for XBee Cellular 3G Global:
Table of Contents

Advertisement

Quick Links

Download this manual
Digi XBee® Cellular 3G Global
Embedded Modem
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XBee Cellular 3G Global and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Digi XBee Cellular 3G Global

Summary of Contents for Digi XBee Cellular 3G Global

  • Page 1 Digi XBee® Cellular 3G Global Embedded Modem User Guide...
  • Page 2 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.
  • Page 3 To provide feedback on this document, email your comments to techcomm@digi.com Include the document title and part number (Digi XBee Cellular 3G Global Embedded Modem User Guide, 90001541 L) in the subject line of your email. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 4: Table Of Contents

    Contents Digi XBee Cellular 3G Global Embedded Modem User Guide Applicable firmware and hardware SIM cards Cellular service Get started with the XBee Cellular Modem Identify the kit contents Connect the hardware Install and upgrade XCTU Add a device to XCTU...
  • Page 5 Update the firmware using web services in Remote Manager Use a host processor to update the modem firmware for XBee devices over UART Technical specifications Interface and hardware specifications RF characteristics Networking specifications Power requirements Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 6 Data network connection Data communication with remote servers (TCP/UDP) Disconnecting Modes Select an operating mode Transparent operating mode API operating mode Bypass operating mode (DEPRECATED) Enter Bypass operating mode Leave Bypass operating mode Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 7 Low power operation Select the SPI port Force UART operation Data format File system Overview of the file system Directory structure Paths Secure files XCTU interface Encrypt files SMS behaviors SMS encoding Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 8 Designate the socket as a listener Receive a Socket Bind/Listen Response Making a connection to the listener socket Receiving Data from the new socket Receive a Socket Status indicating closed connection Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 9 TS (IP Server Connection Timeout) DO (Device Options) Addressing commands SH (Serial Number High) SL (Serial Number Low) MY (Module IP Address) P# (Destination Phone Number) N1 (DNS Address) N2 (DNS Address) Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 10 Firmware version/information commands VR (Firmware Version) VL (Verbose Firmware Version) HV (Hardware Version) AI (Association Indication) HS (Hardware Series) CK (Configuration CRC) Diagnostic interface commands DI (Remote Manager Indicator) CI (Protocol/Connection Indication) Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 11 AT Command Response - 0x88 Transmit (TX) Status - 0x89 Modem Status - 0x8A Receive (RX) Packet: SMS - 0x9F Receive (RX) Packet: IPv4 - 0xB0 User Data Relay - 0x2D Example use cases Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 12 2.2 List of applicable FCC rules 2.3 Summarize the specific operational use conditions 2.4 Limited module procedures 2.5 Trace antenna designs 2.6 RF exposure considerations 2.7 Antennas 2.8 Label and compliance information Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 13 FCC (USA) exposure notice ISED (Canada) exposure notice Labeling requirements for the host device Europe (CE) Maximum power and frequency specifications OEM labeling requirements Declarations of conformity ACMA (Australia) RSM (New Zealand) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 14: Digi Xbee Cellular 3G Global Embedded Modem User Guide

    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. Digi International periodically releases new firmware containing bug fixes and new features. As new firmware is released and distributor stock is refreshed, the new firmware will gradually become available without the need to update.

  • Page 15: Cellular Service

    Cellular service Digi now offers Cellular Bundled Service plans. This service includes pre-configured cellular data options that are ideal for IoT applications, bundled together with Digi Remote Manager for 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: By phone: 1-877-890-4014 (USA/toll free) or +1-952-912-3456 (International).

  • Page 16: Get Started With The Xbee Cellular Modem

    2. Review introductory MicroPython examples. You can use MicroPython to enhance the intelligence of the XBee to enable you to do edge-computing by adding business logic in MicroPython, rather than using external components. Example: hello world Example: turn on an LED Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 17: Identify The Kit Contents

    One 12 V power supply One cellular antenna with U.FL connector One USB cable One XBee Cellular Modem Note The XBee Cellular Modem comes attached to the board in ESD wrap. One SIM card Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 18: Connect The Hardware

    4. Plug the 12 V power supply to the power jack on the development board. 5. Connect the USB cable from a PC to the USB port on the development board. The computer searches for a driver, which can take a few minutes to install. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 19: Install And Upgrade Xctu

    Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices. XCTU does not work directly over an SPI interface.

  • Page 20: Update The Device Firmware Using Xctu

    MY (Module IP Address) should display a valid IP address. If it reads 0.0.0.0, it has not registered yet. Note To read a command's value, click the Read button next to the command. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 21 Check with your carrier provider to determine whether internet access is restricted. Connect to the Echo server Connect to the ELIZA server Connect to the Daytime server Perform a (GET) HTTP request Connect to a TCP/IP address Debugging Software libraries Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 22: Xbee Connection Examples

    For instructions on using the Console, see the AT console topic in the XCTU User Guide. 10. Click the Open button to open a serial connection to the device. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 23: Connect To The Eliza Server

    6. To enter the destination address of the ELIZA Therapist Bot, in the DL field, type 52.43.121.77 and click the Write button. 7. To enter the destination IP port number, in the DE field, type 2328 and click the Write button. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 24: Connect To The Daytime Server

    IP (IP Set the expected transmission mode to TCP communications. Protocol) 52.43.121.77 The target IP of the Daytime server. (Destination Address) 0x232A The target port number of the Daytime server. (Destination Port) Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 25 11. Click in the left pane of the Console log, then type in the Console to query the Daytime server. The following screenshot provides an example of this chat. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 26: Perform A (Get) Http Request

    The HTTP protocol requires an empty line (a line with nothing preceding the CRLF) to terminate the request. 15. Click Add packet. 16. Click the Open button 17. Click Send selected packet. 18. A GET HTTP response from httpbin.org appears in the Console log. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 27: Connect To A Tcp/Ip Address

    After exiting Command mode, any UART data sent to the device is sent to the destination IP address and port number after the RO (Packetization Timeout) occurs. Debugging If you experience problems with the settings in the examples, you can load the default settings in XCTU. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 28: Software Libraries

    The XBee Python Library is a Python API that dramatically reduces the time to market of XBee projects developed in Python and facilitates the development of these types of applications, making it an easy process. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 29: Get Started With Digi Remote Manager

    Get started with Digi Remote Manager Digi Remote Manager® is a cloud-based device and data management platform that you can use to configure and update a device, and view and manage device data. The sections below describe how to create a Remote Manager account, upgrading your device, configure your device, and manage data in Remote Manager.

  • Page 30: Create A Remote Manager Account

    Create a Remote Manager account and add devices Create a Remote Manager account Digi Remote Manager is an on-demand service with no infrastructure requirements. Remote devices and enterprise business applications connect to Remote Manager through standards-based web services. This section describes how to configure and manage an XBee using Remote Manager. For...

  • Page 31: Verify The Connection Between A Device And Remote Manager

    The following provides a template of how to create a schedule for an XBee to connect, perform a set of tasks and then disconnect: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 32: Examples

    9. Click Run Now. Examples The examples in the following sections assume you are using the Digi Remote Manager Schedule wizard. However, you should be aware that operations can be created and performed programmatically via web service calls or via the API explorer. The XML web service calls provide more options than are available in the GUI dashboard for some tasks.

  • Page 33: Example: Configure A Device From Remote Manager Using Xml

    See Schedule walk-through feature in the Digi Remote Manager® User Guide more information. 4. In the Description field, enter a name for the schedule, such as "Configure Reporting Frequency." Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 34: Example: Schedule A Task To Update The Device Firmware Using Remote Manager

    You must upgrade your device to the latest firmware for all features to be available. See Update firmware. To upgrade using a scheduled task perform the following steps: 1. Download the updated firmware file for your device from Digi's support site. a. Go to the Digi XBee Cellular 3G support page.

  • Page 35: Example: Update Micropython From Remote Manager Using Xml

    Click Create. The new file is added to the list of files. d. Find the "MicroPython" folder in the folder list. e. Click Upload Files. The Upload Files dialog displays. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 36 </command> <command> <name>RCI Command</name> <event> <on_error> <continue/> </on_error> </event> <sci> <send_message cache="false" allowOffline="true" > <!-- Disable Python Auto-start and enable TCP connection for remainder of commands--> <rci_request> <set_setting> <micropython> <PS>0</PS> </micropython> Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 37 </commands> </file_system> </sci> </command> <command> <name>Upload Files</name> <event> <on_error> <continue/> </on_error> </event> <sci> <file_system allowOffline="true" > <commands> <put_file path="/flash/lib/uftp.py"> <file>~/MicroPython/uftp.py</file> </put_file> </commands> </file_system> </sci> </command> <command> <name>RCI Command</name> <event> <on_error> <continue/> Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 38 3. Click SCI Targets. The Select devices to be used in examples dialog appears. a. From the Add Targets list box, search for the IMEI (device ID) of the device that you want to update. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 39: Manage Data In Remote Manager

    7. Click on the status group that has information you want to display. The status information is related to AT commands. For information about each AT command in the categories, click on the appropriate link below. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 40: Manage Secure Files In Remote Manager

    5. Select the device that you want to configure. 6. Click Properties in the toolbar. As an alternative, double-click on the device name. The Properties page appears. 7. Click File Management. The File Management view appears. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 41: Remote Manager Reference

    Example: Schedule a task to update the device firmware using Remote Manager. Note If you wish to restore the persistent connection behavior that was the default in prior firmware versions, see Restore persistent connection to a remote XBee. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 42 Change the RCI command to the following: <rci_request> <set_setting> <remote_manager> <MO>7</MO> </remote_manager> </set_setting> </rci_request> 7. Click Schedule in the lower right corner of the dialog to schedule the tasks to run. The schedule screen displays. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 43: Disconnect

    Configuration. The configuration Home page appears. 6. Click Config in the toolbar to display the settings sub-menus. 7. Click on the settings category that you want to configure. The settings in that category appear. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 44 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 cellular data usage, depending on your plan. The commands can be used to tune the keepalive interval. Your carrier will disconnect an inactive socket automatically if there is no activity, so you need to tune this value based on your carrier’s disconnect timeout.

  • Page 45: Examples: Iot Protocols With Transparent Mode

    The following examples provide 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 Get started with MQTT Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 46: Get Started With Coap

    The following diagram shows the message format for the CoAP protocol; see ISSN: 2070-1721 details: This is an example GET request: 44 01 C4 09 74 65 73 74 B7 65 78 61 6D 70 6C 65 Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 47: Configure The Device

    Read to get an update on the AI value. Example: manually perform a CoAP request Follow the steps in Configure the device prior to this example. This example performs the CoAP GET request: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 48: Example: Use Python To Generate A Coap Message

    HTTP protocol and how to do this using the XBee Cellular Modem. In this example, the XBee Cellular Modem talks to a CoAP Digi Server. You can use this client code to provide an abstract wrapper to generate a CoAP message that commands the XBee Cellular Modem to talk to the remote CoAP server.
  • Page 49 In the following figure, the payload contains the server response to the query. It shows the results for when you press Enter rather than Y. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 50: Get Started With Mqtt

    Description Hex value CONNECT packet fixed header byte 1 Control packet type 0x10 byte 2 Remaining length 0x10 CONNECT packet variable header Protocol name byte 1 Length MSB (0) 0x00 Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 51 Clean Session flag, which indicates to the client and broker to discard any previous session and start a new one. Keep Alive How often the client pings the broker to keep the connection alive; in this example it is set to 60 seconds. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 52: Send A Connect Packet

    The length of the ID (in bytes) precedes the ID itself. Each client connecting to a broker must have a unique client ID. In the example, the ID is DIGI. When using the Paho MQTT Python libraries, a random alphanumeric ID is generated if you do not specify an ID.

  • Page 53: Example: Send Messages (Publish) With Mqtt

    A basic Python example of a node publishing (sending) a message is: mqttc = mqtt.Client("digitest") # Create instance of client with client ID “digitest” mqttc.connect("m2m.eclipse.org", 1883) # Connect to (broker, port, keepalive-time) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 54: Example: Receive Messages (Subscribe) With Mqtt

    # Define callback function for successful connection client.on_message = on_message # Define callback function for receipt of a message # client.connect("m2m.eclipse.org", 1883, 60) # Connect to (broker, port, keepalive-time) client.connect('127.0.0.1', 17300) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 55: Use Mqtt Over The Xbee Cellular Modem With A Pc

    4. You can make the proxy with a dual-threaded Python script, a simple version follows: import threading import serial import socket def setup(): """ This function sets up the variables needed, including the serial port, and it's speed/port settings, listening socket, and localhost adddress. """ Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 56 - socket has closed. Exiting socket reader thread.") return 1 # Exit the thread to avoid a loop of 0-byte receptions else: print("Received {} bytes from client via socket.".format(len (data))) Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 57 MQTT client to use the data connection provided by the device. Think of the proxy script as a translator between the MQTT client and the XBee Cellular Modem. The following figure shows the basic operation. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 58 To avoid these errors, it is best to start the scripts in the correct order: proxy, then subscribe, then publish. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 59 Use XCTU to enter the MicroPython environment Use the MicroPython Terminal in XCTU Example: hello world Example: turn on an LED Example: debug the secondary UART Exit MicroPython mode Other terminal programs Use picocom in Linux Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 60: Get Started With Micropython

    4. Set the device's baud rate to 115200 b/s, in the BD field select 115200 [7] or higher and click the Write button . We recommend using flow control to avoid data loss, especially when pasting large amounts of code/text. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 61: Use The Micropython Terminal In Xctu

    1. Note the DS4 LED on the XBIB board. The following image highlights it in a red box. The LED is normally off. Other terminal programs if you do not use the MicroPython Terminal in XCTU. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 62: Example: Debug The Secondary Uart

    You have successfully controlled an LED on the board using basic I/O. Example: debug the secondary UART This sample code is handy for debugging the secondary UART. It simply relays data between the primary and secondary UARTs. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 63: Exit Micropython Mode

    Tera Term, if you use Linux, follow the instructions for picocom. To download these programs: Tera Term for Windows; see https://ttssh2.osdn.jp/index.html.en. Picocom for Linux; see https://developer.ridgerun.com/wiki/index.php/Setting_up_Picocom_-_ Ubuntu and for the source code and in-depth information https://github.com/npat- efault/picocom. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 64: Tera Term For Windows

    CR if it does not already show that value. c. Make sure the Local echo box is not checked. 9. Click OK. 10. Press Ctrl+B to get the MicroPython version banner and prompt. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 65: Use Picocom In Linux

    3. Check the directory again and you should see one additional device, which is the XBee Cellular Modem. 4. In this case, replace /dev/ttyUSB0 at the top with /dev/ttyUSB<number>, where <number> is the new number that appeared. 5. It should connect and show Terminal ready. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 66 Get started with MicroPython Use picocom in Linux Now you can type MicroPython commands at the >>> prompt. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 67: Update The Firmware

    You should update your XBee to the latest firmware to take advantage of all the latest fixes and features. Refer to the topics below for 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 firmware updates.

  • Page 68: Create A Plan For Device Component Firmware Updates

    For Cellular 3G modems, you cannot update the firmware on the cellular component. Note Digi will not accept responsibility for customers who have not planned to update their units. Please review the information provided below. Please review the suggestions below: If updates will be performed using a PC, XCTU version 6.5.0 or later is able to perform device...

  • Page 69: Update The Device Firmware

    You should update the device firmware on your XBee to the latest version to take advantage of all the latest fixes and features. Security issues or software bugs may be identified which require firmware updates to resolve. In addition, Digi periodically releases new firmware which includes new features and improves reliability and performance of existing features.

  • Page 70: Update The Firmware Using Web Services In Remote Manager

    Before you begin, verify the TCP connection method your device uses to connect to Remote Manager: query once a day or use a persistent TCP connection. See connection. To perform a firmware update: 1. Download the updated firmware file for your device from Digi's support site. a. Go to the Digi XBee Cellular 3G support page.
  • Page 71 2. Unzip the file and locate the .ebin inside the unzipped directory. 3. Log in to Remote Manager. 4. Click the Data Services tab. 5. Click Data Files. 6. Click Upload Files; browse and select the *.ebin firmware file to upload it. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 72: Use A Host Processor To Update The Modem Firmware For Xbee Devices Over Uart

    Send the %P command. The %P command must be sent an argument derived from the SL parameter of the module being updated. The argument is the value of SL added to the value 0xDB8A and then masked by performing a bitwise-AND with 0x3FFF. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 73 Change your baud rate to match the max supported rate. If the bootloader does not answer to this command, remain at the current rate. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 74 Verify that the answer to this command is 0x55 (ACK). Any other result is an error. 5. Wait a couple of seconds for the firmware to be installed and start running. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 75 Technical specifications Interface and hardware specifications RF characteristics Networking specifications Power requirements Power consumption Electrical specifications Regulatory approvals Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 76: Technical Specifications

    Band 8 (900 MHz) Band 2 (1900 MHz) Band 1 (2100 MHz) Security Digi Trustfence™ security with secure boot, encrypted storage, protected JTAG, TLS 1.2 DO (Device Options) for more information on enabling and using the 2G fallback feature. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 77: Power Requirements

    72 mA Sleep current Not connected, Deep 10 µA Sleep @ 3.3 V Electrical specifications The following table provides the electrical specifications for the XBee Cellular Modem. See the 2G fallback power consumption table for further details. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 78: Regulatory Approvals

    I/O pins to Ground or VCC_IO Internal Enabled kΩ pull-up resistor Internal Enabled kΩ pull-down resistor Regulatory approvals The following table provides the regulatory and carrier approvals for the device. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 79 Innovation, Science and Economic Development Canada Contains IC: 8595A-1CGM5NNN (ISED) Europe (CE) Australia ACMA Yes, RCM New Zealand RSM Yes, R-NZ RoHS Lead-free and RoHS compliant PTCRB certification AT&T end device certified Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 80: Hardware

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

  • Page 81: Mechanical Drawings

    Pin signals The pin locations are: The following table shows the pin assignments for the through-hole device. In the table, low-asserted signals have a horizontal line above signal name. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 82 Analog Input 2 or Digital I/O 2, SPI Clock line AD1 / DIO1 / SPI_ATTN Analog Input 1 or Digital I/O Either Disabled 1, SPI Attention line output AD0 / DIO0 Either Input Analog Input 0, Digital I/O 0 Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 83: Pin Connection Recommendations

    The following table describes the Associate LED functionality. For the location of the Associate LED on the XBIB-U development board, see number 6 on the XBIB-U-DEV reference. Blink LED status timing Meaning On, solid Not joined to a mobile network. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 84 Where the low signal means LED off and the high signal means LED on. When CI is not 0 or 0xFF, the Associate LED has a different blink pattern that looks like this: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 85: Development Boards

    Hardware Development boards Development boards XBIB-U-DEV reference This picture shows the XBee USB development board and the table that follows explains the callouts in the picture. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 86 Powering the board with J2 and J5 without R31 removed can cause shorts if the USB or barrel plug power are connected. Applying too high a voltage destroys electronic circuitry in the device and other board components and/or can cause injury. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 87: Xbib-Cu-Th Reference

    Hardware Development boards 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 This module is sold separately. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 88 USB-C connector is not powering the UART. Note Power supply outputs 3.3V to XBee regardless of input voltage as long as current requirement can be met to achieve power consumption of devices. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 89 USB micro port for correct operation of the I2C sensor. XBee Socket This is the socket for the XBee (TH form factor). XBee Test Allows easy access to pins 1 to 20 of the XBee. Point Pins Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 90: Xbib-C-Gps Reference

    Note This GPS module is sold separately and requires an XBIB-CU-TH development board. Note You run a demo using MicroPython to parse UART to GPS communications. see Run the MicroPython GPS demo. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 91: Interface With The Xbib-C-Gps Module

    MicroPython capabilities). There are two ways to interface with the XBIB-C-GPS board: through the host board’s Secondary UART or through the I2C compliant lines. The following picture shows a typical setup: Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 92 For more information about using Micro Python to communicate to 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 If you are unfamiliar with MicroPython on XBee, see Get started with MicroPython.

  • Page 93: Antenna Recommendations

    For optimal cellular reception, 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 efficiency. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 94 Design recommendations Power supply considerations Add a capacitor to the RESET line Heat considerations Custom configuration: Create a new factory default Clean shutdown Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 95: Design Recommendations

    The gasket should be thick enough to ensure that contact with the tallest component does not cause damage when pressure is applied to a secure heat sink. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 96: Add A Fan To Provide Active Cooling

    If there is no space left to save a configuration, XBee returns an error. You can use the !C command to clear or overwrite a custom configuration at any time. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 97: Set A Custom Configuration

    WARNING! Improper shutdown of the modem may result in the underlying cellular module becoming irrecoverably unresponsive. Digi strongly recommends performing a clean shutdown procedure on your XBee cellular devices before removing power from the devices. Performing a shutdown allows the module to unregister from the cellular network and safely store operating parameters.

  • Page 98: Sleep Feature

    Change the XBee configuration to use Airplane mode (AM=1). This puts the XBee into a safe state for shutdown. 1. Set AM=1. 2. Apply configuration change. 3. Wait 30 seconds to allow time for shutdown to occur. 4. Power off the device. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 99: Cellular Connection Process

    Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 100: Connecting

    3. The cellular network may also close the connection after a timeout set by the network operator. Disconnecting When the XBee Cellular Modem is put into Airplane mode, deep sleep is requested, or ATSD (shutdown) command is executed: Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 101 2. The cellular connection is shut down. 3. The cellular component is powered off. Note We recommend entering Airplane mode before resetting or rebooting the device to allow the cellular module to detach from the network. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 102: Modes

    Modes Select an operating mode Transparent operating mode API operating mode Bypass operating mode (DEPRECATED) Command mode MicroPython mode Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 103: Select An Operating Mode

    API operating mode, and Bypass operating mode. The default mode is Transparent operating mode. Use the AP (API Enable) command to select a different operating mode. The following flowchart illustrates how the modes relate to each other. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 104: Transparent Operating Mode

    Bypass operating mode exists for users who wish to communicate directly with the cellular component settings and do not intend to use XBee Cellular Modem software features such as API mode. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 105: Enter Bypass Operating Mode

    Command mode successfully and is ready to start processing AT commands. If configured to operate in Transparent operating mode, when entering Command mode the XBee Cellular Modem knows to stop sending data and start accepting commands locally. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 106: Troubleshooting

    AC (Apply Changes). Parameter format Refer to the list of AT commands for the format of individual AT command parameters. Valid formats for hexidecimal values include with or without a leading 0x for example FFFF or 0xFFFF. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 107: Response To At Commands

    MicroPython stack of the XBee Cellular Modem through the serial interface. MicroPython mode connects the primary serial port to the stdin/stdout interface on MicroPython, which is either the REPL or code launched at startup. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 108 MicroPython mode 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 on stdin. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 109 Sleep modes About sleep modes Normal mode Pin sleep mode Cyclic sleep mode Cyclic sleep with pin wake up mode Airplane mode The sleep timer MicroPython sleep behavior Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 110: About Sleep Modes

    AM (Airplane Mode) to configure this mode. The sleep timer The sleep timer starts when the device wakes and resets on re-configuration. When the sleep timer expires the device returns to sleep. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 111: Micropython Sleep Behavior

    (b'', (<address from connect()>, <port from connect()>) ) The underlying UDP socket resources have been released at this point. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 112: Serial Communication

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

  • Page 113: Serial Interface

    Devices that have a UART interface connect directly to the pins of the XBee Cellular Modem 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. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 114: Serial Buffers

    RTS flow control, the device does not send data in the serial transmit buffer out the DOUT pin as long as RTS is de-asserted (set high). Do not de-assert RTS for long periods of time or the serial transmit buffer will fill. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 115: Spi Operation

    SPI operation SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Data format Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 116: Spi Communications

    The following diagram shows the frame format mode 0 for SPI communications. SPI mode is chip to chip communication. We do not supply a SPI communication option on the device development evaluation boards. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 117: Full Duplex Operation

    SPI slave to start receiving another valid frame. The following figure illustrates the SPI interface while valid data is being sent in both directions. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 118: Low Power Operation

    By default, Digi configures DIO8 (SLEEP_REQUEST) as a peripheral and during pin sleep it wakes the device and puts it to sleep. This applies to both the UART and SPI serial interfaces.

  • Page 119: Force Uart Operation

    The XBee Cellular Modem sends 0xFF when there is no data to send to the host. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 120: File System

    File system For detailed information about using MicroPython on the XBee Cellular Modem refer to the Digi MicroPython Programming Guide. Overview of the file system XCTU interface Encrypt files Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 121: Overview Of The File System

    SHA256 hash of file contents available from ATFS HASH command (to compare with a local copy of a file). Encrypted on the SPI flash. MicroPython can execute code in secure files. Sockets can use secure files when creating TLS connections. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 122: Xctu Interface

    SHA256 hash of the file contents. In this way you can validate that the correct file has been placed on the XBee Cellular Modem. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 123: Sms Behaviors

    The device converts incoming SMS messages to ASCII. Characters that cannot be represented in ASCII are replaced with a space (' ', or 0x20 in hex). This includes emoji and other special characters. Also referred to as the GSM 7-bit alphabet. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 124 API mode behavior for incoming UDP data Transparent mode behavior for outgoing TCP and TLS connections Transparent mode behavior for outgoing UDP data Transparent mode behavior for incoming TCP connections Transparent mode behavior for incoming UDP connections Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 125: Socket Behavior

    Timeout)) or when the socket is closed via a TX request with the CLOSE flag set. 1 UDP socket is always reserved for DNS, so subtract 1 socket from the values above. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 126: Enable Incoming Tcp Sockets In Api Mode

    XBee Cellular Modem's serial port specifying the destination address and destination port of the remote host. If you use a source port of 0, the device creates a new socket for the purpose of sending Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 127: Api Mode Behavior For Incoming Tcp Connections

    UDP, any data sent from a remote host to the XBee Cellular Modem's network port specified by the C0 (Source Port) setting is sent out the XBee Cellular Modem's Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 128: Transparent Mode Behavior For Outgoing Tcp And Tls Connections

    Any data received on the connection is sent out the XBee Cellular Modem's serial port. Any data sent to the XBee Cellular Modem's serial port is sent over the connection. If the connection is disconnected, it discards pending data. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 129: Transparent Mode Behavior For Incoming Udp Connections

    Any data sent to the XBee Cellular Modem's serial port is sent to the network destination specified by DL (Destination Address) DE (Destination port) settings. If the DL and DE settings are unspecified or invalid, the XBee Cellular Modem discards data sent to the serial port. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 130: Extended Socket Frames

    Paste the provided frame content directly into the Add API frame to list window in XCTU to follow along manually. Extended Socket example: Single HTTP Connection Extended Socket example: UDP Extended Socket example: TCP Listener Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 131: Available Extended Socket Frames

    This example demonstrates a complete request with an HTTP server. It fetches a random fact about a number from a web services API offered by the website http://numbersapi.com. Note Digi is not affiliated with numbersapi.com and the example is for education only. Send a Socket Create frame Note...

  • Page 132: Receive A Socket Create Response

    The request to connect is immediately acknowledged with a response. However, it is not permitted to proceed transmitting data until the next stage, after a Socket Status frame has been received indicating success. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 133: Receive A Socket Status

    This allows the example to demonstrate the Socket Status reporting of a close by the peer. Field Value 0x44 (Socket Status) Frame type Frame ID 0x01 Socket ID 0x00 Transmit Options 0x00 GET /random/trivia HTTP/1.1 Data Host: numbersapi.com Connection: close Socket Send frame data: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 134: Receive Tx Status

    Access-Control-Allow-Headers: X-Requested-With X-Numbers-API-Number: 270 X-Numbers-API-Type: trivia Pragma: no-cache Cache-Control: no-cache Expires: 0 270 is the average number of days in human pregnancy. Receive Data received from XBee containing web service response: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 135: Receive Socket Status Indicating Closed Connection

    Send a Socket Create frame Field Value 0x40 (Socket Create) Frame type Frame ID 0x01 Protocol 0x00 (UDP) UDP Socket Create frame data: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 136: Receive A Socket Create Response

    The XBee generates a response indicating the status of the request to bind the requested port. Field Value 0xC6 (Socket Bind/Listen Response) Frame type Frame ID 0x01 Socket ID 0x00 Status 0x00 (Success) Socket Bind/Listen Response received from XBee: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 137: Send To Digi Echo Server

    Extended Socket frames Extended Socket example: UDP 7E 00 04 C6 01 00 00 38 Send to Digi echo server Digi hosts a server at 52.43.121.77 port 10001 which echos all UDP traffic sent to it. Field Value 0x45 (Socket SendTo)

  • Page 138: Send To Digi Time Server

    7E 00 13 CE 00 00 34 2B 79 4D 27 11 00 65 63 68 6F 20 74 68 69 73 5D Send to Digi time server Digi hosts a server at 54.43.121.77 port 10002 which will reply with the time when it receives a packet.

  • Page 139: Close The Socket

    Finally, the XBee indicates the socket has been closed with a Socket Close Response frame. Field Value 0xC3 (Socket CloseResponse) Frame type Frame ID 0x01 Socket ID 0x00 Status 0x00 (Success) Socket Close Response received from XBee: 7E 00 04 C3 01 00 00 3B Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 140: Extended Socket Example: Tcp Listener

    The Socket Bind/Listen Frame takes the socket ID from the socket create response and a source port that the socket will then listen on. In this example port 10001 is used. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 141: Receive A Socket Bind/Listen Response

    It contains the listener's socket ID and the new Client Socket ID along with the connection's remote address information. Field Value 0xCC (Socket New IPv4 Client) Frame type Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 142: Receiving Data From The New Socket

    You may close the client socket remotely which elicits a Socket Status with a Status of 0x07. Field Value 0xCF (Socket Status) Frame type Socket ID 0x01 Status 0x07 (Connection lost) Socket Status received from XBee indicating connection lost: 7E 00 03 CF 01 07 28 Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 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 operations are possible or necessary using that ID. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 144 Transparent mode and TLS API mode and TLS Key formats Certificate formats Certificate limitations Cipher suites Server Name Indication (SNI) Secure the connection between an XBee and Remote Manager with server authentication Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 145: Transport Layer Security (Tls)

    2. Server authentication: Only ca_cert is provided. Only the servers identity is checked 3. Mutual authentication: All items are provided and both sides are assured of the identity of their peer It is not possible to only have client authentication. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 146: Transparent Mode And Tls

    Digi's implementation does not support encrypted keys, we use file system encryption to protect the keys at rest in the system. Certificate formats The XBee Cellular 3G Global Embedded Modem does not support X509 v3 certificates and extensions for the client certificate. However, v3 certificates are fine for CA certificates used in server authentication.

  • Page 147: Server Name Indication (Sni)

    1. Verify the following settings: Setting Value Bit 0 (mask 0x1) must be set. This enables the use of Digi Remote Manager within the firmware. Bit 1 (mask 0x2) must be set. When this value is set the Remote Manager TCP connection will be secured with TLS.

  • Page 148: Step 3: Verify That Authentication Is Being Performed

    6 to verify that the server was correctly authenticated. 0: Connected without TLS 5: Connected with TLS but without authentication 6: Connected with TLS and with authentication Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 149: At Commands

    I/O settings commands I/O sampling commands Sleep commands Command mode options MicroPython commands Firmware version/information commands Diagnostic interface commands Execution commands File system commands Remote Manager commands System commands Socket commands Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 150: Special Commands

    If you issue FR while the device is in Command Mode, the reset effectively exits Command mode. Note Digi recommends shutting down the cellular component before resetting or rebooting the device to allow the cellular module to detach from the network. The cellular component can be shut down by issuing the command.

  • Page 151: Sd (Shutdown)

    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. Parameter range Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 152: Cellular Commands

    Reads the IMSI (International Mobile Subscriber Identity) from the SIM inserted into the module. Parameter range Default MN (Operator) Reads the network operator on which the device is registered. Parameter range Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 153: Mv (Modem Firmware Version)

    The response is the number of seconds since 2000-01-01 00:00:00, as a 32- bit number. This is the default. The response is the current date and time in ISO 8601 format. For example, "2018-12-25T22:00:05". Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 154: An (Access Point Name)

    0x20: A single ASCII space character that indicates there is no PIN. PK (SIM PUK) Specifies the PUK for unlocking a SIM. This is needed only if the wrong PIN was used and the SIM is locked out. This command is write-only. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 155: Cu (Cellular User Name)

    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 indicates there is no cellular password. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 156: Network Commands

    Specifies the TLS certificate(s) to use in Transparent mode (when IP (IP Protocol) = 4) or API mode (Transmit (TX) Request: IPv4 - 0x20 Tx Request with TLS Profile - 0x23 with profile set to 0). Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 157: Tls Profile 1)

    If you change the TM value while in API Mode, the value only applies to subsequently opened sockets. TM does not apply to explicit sockets. Parameter range 0 - 0xFFFF [x 100 ms] Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 158: Ts (Ip Server Connection Timeout)

    3. Wait for the cellular component to be initialized: AI (Association Indication) reaches 0x00. The following table provides the 2G power consumption at 3.8 V and room temperature. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 159 GPRS connected mode, max TX power (4 TX, 1 RX slot) 700 mA 2.6 A EDGE connected mode, max TX power (4 TX, 1 RX slot) 280 mA 2.6 A 2G active mode 80 mA Default 1 (Bit 0 enabled) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 160: Addressing Commands

    011 for the United States. Range 5 - 20 ASCII digits including an optional + prefix Note In device firmware versions ending in *10 or earlier, the range is 7-20 ASCII digits. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 161: N1 (Dns Address)

    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 dotted-quad string notation. Parameter range Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 162: Destination Port)

    When you issue LA in API mode, the IP address is formatted in binary four byte big-endian numeric value. In all other cases (for example, Command mode) the format is dotted decimal notation. Range Valid FQDN Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 163: Serial Interfacing Commands

    0x3 (9600 b/s) NB (Parity) Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x02 Parameter Description 0x00 No parity 0x01 Even parity 0x02 Odd parity Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 164: Sb (Stop Bits)

    To use a carriage return, set to 0xD. Set to zero to disable text delimiter checking. Parameter range 0 - 0xFF Default FT (Flow Control Threshold) Set or display the flow control threshold. The device de-asserts CTS when FT bytes are in the UART receive buffer. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 165: Ap (Api Enable)

    Parameter range 0x00 - 0x05 Parameter Description 0x00 API disabled (operate in Transparent mode) 0x01 API enabled 0x02 API enabled (with escaped control characters) 0x03 0x04 MicroPython REPL 0x05 Bypass mode Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 166: I/O Settings Commands

    Default D1 (DIO1/AD1) Sets or displays the DIO1/AD1 configuration (pin 19). Parameter range 0 - 6 Parameter Description Disabled SPI_ATTN Digital input Digital output, low Digital output, high I2C SCL Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 167: D2 (Dio2/Ad2)

    SPI_SSEL Analog input Digital input Digital output, default low Digital output, default high Default D4 (DIO4) Sets or displays the DIO4 configuration (pin 11). Parameter range 0, 1, 3 - 5 Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 168: D5 (Dio5/Associated_Indicator)

    Digital output, default low Digital output, default high Default D6 (DIO6/RTS) Sets or displays the DIO6/RTS configuration (pin 16). Parameter range 0, 1, 3 - 5 Parameter Description Disabled RTS flow control Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 169: D7 (Dio7/Cts)

    D8 (DIO8/SLEEP_REQUEST) Sets or displays the DIO8/DTR/SLP_RQ configuration (pin 9). Parameter range 0, 1, 3 - 5 Parameter Description Disabled SLEEP_REQUEST input Digital input Digital output, default low Digital output, default high Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 170: D9 (Dio9/On_Sleep)

    0 - 5 Parameter Description Disabled RSSI PWM0 output PWM0 output Digital input Digital output, low Digital output, high Default P1 (DIO11/PWM1 Configuration) Sets or displays the DIO11 configuration (pin 7). Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 171: P2 (Dio12 Configuration)

    The resistor pull direction bit field (1 = pull-up, 0 = pull-down) for corresponding I/O lines that are set PR (Pull-up/down Resistor Enable). If the bit is not set in PR, the device uses PD. Note Resistors are not applied to disabled lines. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 172: Pr (Pull-Up/Down Resistor Enable)

    3 DIO5/ASSOCIATE pin 15 DIO9/On/SLEEP pin 13 DIO12 pin 4 DIO10 pin 6 DIO11 pin 7 DIO7/CTS pin 12 DIO13/DOUT pin 2 Parameter range 0 - 0x7FFF (bit field) Default 0x7FFF Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 173: M0 (Pwm0 Duty Cycle)

    The PWM period is 42.62 µs and there are 0x03FF (1023 decimal) steps within this period. When M0 = 0 (0% PWM), 0x01FF (50% PWM), 0x03FF (100% PWM), and so forth. Parameter range 0 - 0x3FF Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 174: I/O Sampling Commands

    Each field is a binary number of the size listed in the following table. Multi-byte fields are in big-endian byte order. Field Size Number of samples 1 byte Digital channel mask 2 bytes Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 175 AT commands I/O sampling commands Field Size Analog chanel mask 1 byte Samples 2 bytes each Parameter range Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 176: Sleep Commands

    Default 0x7530 (5 minutes) ST (Wake Time) Sets or displays the time to spend awake in cyclic sleep modes. Parameter range 0x1 - 0x36EE80 (x 1 ms) Default 0xEA60 (60 seconds) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 177: Command Mode Options

    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 - 0x576 (x 1 ms) Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 178 AT commands Command mode options Default 0x3E8 (one second) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 179: Micropython Commands

    2000-01-01T00:00:00 PYE (Erase Bundled Code) PYE interrupts any running code, erases any bundled code and then does a soft-reboot on the MicroPython subsystem. PYV (Version Report) Report the MicroPython version. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 180 Sends KeyboardInterrupt to MicroPython. This is useful if there is a runaway MicroPython program and you have filled the stdin buffer. You can enter Command mode (+++) and send ATPY^ to interrupt the program. Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 181: Firmware Version/Information Commands

    Reads the Association status code to monitor association progress. The following table provides the status codes and their meanings. Status code Meaning 0x00 Connected to the Internet. 0x22 Registering to cellular network. 0x23 Connecting to the Internet. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 182: Hs (Hardware Series)

    Read the device's hardware series number. Parameter range Default Set in the firmware CK (Configuration CRC) Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. Parameter range 0 - 0xFFFFFFFF Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 183: Diagnostic Interface Commands

    The following table provides the parameter's meaning when IP = 0 for UDP connections. Parameter Description 0x00 The socket is open. 0x01 Tried to send but could not. 0x02 Invalid parameters (bad IP/host). Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 184 User closed. 0x22 No network registration. 0x23 No internet connection. 0x24 No server - timed out on connection. 0x25 Unknown server - DNS lookup failed. 0x26 Connection refused. 0x27 Connection lost. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 185 Cellular component stack error. 0x12 A modem update is in-progress. Try again after its completion. 0xFF No SMS state to report (no SMS messages have been sent). Parameter range 0 - 0xFF (read-only) Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 186: Execution Commands

    CAUTION! This command is for advanced users, and you should only use it if the cellular component becomes completely stuck while in Bypass mode. Normal users should never need to run this command. See the FR (Force Reset) command instead. Range Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 187: File System Commands

    Directory names end with a forward slash (/) to differentiate them from files.  Secure files end with a hash mark (#) and you cannot download them. <DIR> ./ <DIR> ../ <DIR> cert/ Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 188: Atfs Put Filename

    Report on the size of the filesystem, showing bytes in use, available, marked bad and total. The report ends with a blank line, as with most multi-line AT command output. Example output: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 189: 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 responds with Formatting..., adds a period every second until the format is complete and ends the response with a carriage return. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 190: Remote Manager Commands

    This command works with the K1 command to limit data usage. See Configure Remote Manager keepalive interval. Note Changing this value causes any currently active Remote Manager connections to be closed and recreated. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 191: Mo (Remote Manager Options)

    TCP connection uses TLS. This is the default. Reserved for future use. Default 6 (Bits 1 and 2 are enabled by default.) $D (Remote Manager certificate) Defines the TLS Remote Manager certificate. Parameter range Default /flash/cert/digi-remote-mgr.pem Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 192: System Commands

    One ASCII space character (0x20). KP (Device Description) Sets or displays a user-defined description for the XBee displayed in Remote Manager. Range Up to 20 ASCII characters Default One ASCII space character (0x20) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 193: Socket Commands

    The list is separated by carriage returns (<CR>) and terminated with an additional carriage return. In both API and command mode the payload/output will have the following format: ID<CR> STATE<CR> PROTOCOL<CR> LOCAL_PORT<CR> REMOTE_PORT<CR> REMOTE_ADDRESS<CR> <CR> Field Description The socket ID. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 194 REMOTE_PORT The remote port of the socket. REMOTE_ADDRESS The remote IPv4 address for the given socket. This is 0.0.0.0 for an unconnected socket. Parameter range 0x00 - 0xFE Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 195: Operate In Api Mode

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

  • Page 196: Api Mode Overview

    Frame data Checksum 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: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 197: Api Operation With Escaped Characters (Ap Parameter = 2)

    To escape an interfering data byte, insert 0x7D and follow it with the byte to be escaped (XORed with 0x20). The following data bytes need to be escaped: 0x7E: start delimiter 0x7D: escape character Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 198 Frame type is the API frame type identifier. It determines the type of API frame and indicates how the Data field organizes the information. Data contains the data itself. This information and its order depend on the what type of frame that the Frame type field defines. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 199 FF. 01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F + B8 = 2FF Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 200: Api Frames

    Socket SendTo (Transmit Explicit Data): IPv4 - 0x45 Socket Bind/Listen - 0x46 Socket Listen Response - 0xC6 Socket New IPv4 Client - 0xCC Socket Receive - 0xCD Socket Receive From: IPv4 - 0xCE Socket Status - 0xCF Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 201: At Command - 0X08

    Byte Command name: two ASCII characters that identify the AT command. command Parameter Byte If present, indicates the requested parameter value to set the given value register. If no characters are present, it queries the register. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 202: At Command: Queue Parameter Value - 0X09

    Byte Command name: two ASCII characters that identify the AT command. command Parameter Byte If present, indicates the requested parameter value to set the given value register. If no characters are present, it queries the register. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 203: Transmit (Tx) Sms - 0X1F

    (0x0) byte. Use numbers and the + symbol only, no other symbols or letters. Payload Variable Data to send as the body of the SMS message. (160 characters maximum) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 204: Transmit (Tx) Request: Ipv4 - 0X20

    1 - Terminate the TCP socket after transmission is complete 0 - Leave the socket open. Closed by timeout, see TM (IP Client Connection Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 205 API frames Transmit (TX) Request: IPv4 - 0x20 Field Field name value Data type Description Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 206: Tx Request With Tls Profile - 0X23

    1 - Terminate the TCP socket after transmission is complete 0 - Leave the socket open. Closed by timeout, see TM (IP Client Connection Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 207 API frames Tx Request with TLS Profile - 0x23 Field Field name value Data type Description Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 208: At Command Response - 0X88

    Status 1 = ERROR 2 = Invalid command 3 = Invalid parameter Parameter Byte Register data in binary format. If the register was set, then this field is value not returned. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 209: Transmit (Tx) Status - 0X89

    Invalid TCP port 0x7A Invalid host address 0x7B Invalid data mode Invalid interface. See User Data Relay - 0x2D. 0x7C Interface not accepting frames. See User Data Relay - 0x2D. 0x7D Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 210 Socket connection lost 0x82 No server 0x83 Socket closed 0x84 Unknown server 0x85 Unknown error 0x86 Invalid TLS configuration (missing file, and so forth) 0x87 Socket not connected 0x88 Socket not bound Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 211: Modem Status - 0X8A

    3 = Unregistered with cellular network 0x0E = Remote Manager connected 0x0F = Remote Manager disconnected 0x38 = XBee firmware update started 0x39 = XBee firmware update failed 0x3A = XBee firmware update applying Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 212: Receive (Rx) Packet: Sms - 0X9F

    Data type Description Frame 0x9F Byte Type Phone 20 byte String representation of the phone number, padded out with number string null bytes (0x0). Payload Variable Body of the received SMS message. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 213: Receive (Rx) Packet: Ipv4 - 0Xb0

    16-bit big endian. LSB 11 MSB 12 0 = UDP Protocol 1 = TCP 4 = SSL over TCP Status Reserved Payload Data received from the source. The maximum size is 1500 bytes. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 214: User Data Relay - 0X2D

    Example use cases An external processor outputs the Frame over the UART with the Micropython interface as a target. Micropython operates over the data and publishes the data to mqtt topic. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 215: User Data Relay Output - 0Xad

    Field Field name value Data type Description Frame type 0xAD Byte Byte 0 = Serial port (SPI, or UART when Source interface in API mode) 2 = MicroPython Data Variable Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 216: Socket Create - 0X40

    Reference identifier used to match status responses. A response is required and will be sent regardless of the frame ID. Protocol Byte 0 = UDP 1 = TCP 4 = SSL over TCP Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 217: Socket Create Response - 0Xc0

    Not registered to cell network 0x31 Internal error Resource error: retry the operation later 0x32 Socket limits in API mode. Invalid protocol 0x7B 0x7E A modem update is in process. Try again after its completion. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 218: Socket Option Request - 0X41

    Option ID Option Name Data Type Default Value Description 0x00 0x00 Determines the TLS TLS Profile Byte profile to be used: $0 - $2. This is valid only for TLS sockets. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 219: Socket Option Response - 0Xc1

    0x02: Failed to retrieve option value 0x20: Bad socket ID Option Data Variable Current effective value of the option. This field is only present if the corresponding request was a query (empty value). Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 220: Socket Connect - 0X42

    IPv4 address in network byte address type order. 1: Indicates the destination address field is a string containing either a dotted quad value or a domain name to be resolved. Destination Variable address Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 221: Socket Connect Response - 0Xc2

    Successfully started the connection process 0x01 Invalid destination address type 0x02 Invalid parameter: address or port 0x03 Connection already in progress 0x04 Already connected 0x05 Unknown error 0x20 Invalid socket ID Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 222: Socket Close - 0X43

    If set to 0, the device does not send a response. Socket ID Byte The following options can be used: ID of the socket to be closed. 0xFF: Close all Extended API sockets that are currently open. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 223: Socket Close Response - 0Xc3

    Frame ID Byte A reference identifier used to match status responses. Socket ID Byte ID of the socket that has been closed. 0x00 = Success Status Byte 0x20 = Bad socket ID Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 224: Socket Send (Transmit) - 0X44

    Socket ID Byte ID of the socket to send on. Reserved Transmit options Byte bit-field Payload Variable Data to be transferred to the destination, up to 1500 bytes. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 225: Socket Sendto (Transmit Explicit Data): Ipv4 - 0X45

    ID of the socket to send Destination address 32-bit big endian Destination port 16-bit big endian Transmit options Byte bit-field Reserved Payload Variable Data to be transferred to the destination, up to 1500 bytes. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 226: Socket Bind/Listen - 0X46

    A reference identifier used to match status responses. If set to 0, the device does not send a response. Socket ID Byte The socket ID to listen on. Source port 16-bit big endian The port to listen on. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 227: Socket Listen Response - 0Xc6

    Status code. See table below. Status Byte The following table shows the status codes. Code Description 0x00 Success 0x01 Invalid port 0x02 Error 0x03 Already bound or listening 0x20 Invalid socket ID Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 228: Socket New Ipv4 Client - 0Xcc

    Socket ID Byte The socket ID of the listener socket. Client Socket ID Byte The socket ID of the new connection. Remote address 32-bit big endian Remote port 16-bit big endian Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 229: Socket Receive - 0Xcd

    Socket ID Byte ID of the socket that the data has been received on. Reserved Status Byte bit-field Payload Variable Data received from the destination. It may be up to 1500 bytes. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 230: Socket Receive From: Ipv4 - 0Xce

    ID of the socket that the data has been received on. Source address 32-bit big endian Source port 16-bit big endian Status Byte bit-field Reserved Payload Variable Data to be transferred to the destination, up to 1500 bytes. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 231: Socket Status - 0Xcf

    0x03 = Transport closed 0x04 = Timed out 0x05 = Internal error 0x06 = Host unreachable 0x07 = Connection lost 0x08 = Unknown error 0x09 = Unknown server 0x0A = Resource error Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 232: Troubleshooting

    Cannot find the serial port for the device Correct a macOS Java error Unresponsive cellular component in Bypass mode Not on expected network after APN change Syntax error at line 1 Error Failed to send SMS Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 233: Cannot Find The Serial Port For The Device

    4. Remove the development board from the USB port and view which port name no longer appears in the Discover radio devices list of ports. The port name that no longer appears is the correct port for the development board. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 234: Other Possible Issues

    5. Right-click the USB controller and select Properties; a dialog displays. 6. Select the Advanced tab. 7. Check Load VCP. 8. Click OK. 9. Unplug the board and plug it back in. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 235: Correct A Macos Java Error

    1. Click More info to open a browser window. 2. Click Download to get the file javaforosx.dmg. 3. Double-click on the downloaded javaforosx.dmg. 4. In the dialog, double-click the JavaForOSX.pkg and follow the instructions to install Java. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 236: Unresponsive Cellular Component In Bypass Mode

    XBee Cellular Modem software. If AI is 0x2F, Bypass mode should work. If not, look at the status codes in AI (Association Indication) for guidance. 2. You can send the !R (Modem Reset) command to reset only the cellular component. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 237: Not On Expected Network After Apn Change

    4. The device is not getting enough current, for example if power is being supplied only by USB to the XBIB development board, rather than using an additional external power supply. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 238: Regulatory Information

    Modification statement Interference statement FCC notices FCC Class B digital device notice FCC publication 996369 related information Antennas Labeling requirements for the host device Europe (CE) ACMA (Australia) RSM (New Zealand) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 239: Modification Statement

    Modification statement Modification statement Digi International has not approved any changes or modifications to this device by the user. Any changes or modifications could void the user’s authority to operate the equipment. Digi International n’approuve aucune modification apportée à l’appareil par l’utilisateur, quelle qu’en soit la nature.

  • Page 240: Fcc Publication 996369 Related Information

    FCC grant which includes significant extra testing and cost. If an embedded trace or chip antenna is desired contact a Digi sales representative for information on how to engage with a lab to get the modified FCC grant.

  • Page 241: 2.8 Label And Compliance Information

    Band 5 (850 MHz) 3.42 dBi Band 2 (1900 MHz) 1.51 dBi ISED (Canada) exposure notice This equipment complies with radiation exposure limits prescribed for an uncontrolled environment for fixed and mobile use conditions. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 242: Labeling Requirements For The Host Device

    3.1a and 3.1b of the Radio Equipment Directive. A Declaration of Conformity must be issued for each of these standards and kept on file as described in the Radio Equipment Directive. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 243: Maximum Power And Frequency Specifications

    The CE marking must be affixed visibly, legibly, and indelibly. 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.

  • Page 244: Declarations Of Conformity

    Regulatory information ACMA (Australia) Declarations of conformity Digi has issued Declarations of Conformity for the XBee RF Modules concerning emissions, EMC, and safety. For more information, see www.digi.com/resources/certifications. ACMA (Australia) This certification applies to the XBee Cellular Modem. This module complies with requirements to be used in end products in Australia. All products with EMC and radio communications must have a registered RCM mark.

Table of Contents