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: Customer Support

    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: Table Of Contents

    Contents Digi XBee Cellular 3G Global Embedded Modem User Guide Applicable firmware and hardware Purchase the correct SIM cards Getting started with the XBee Cellular Modem Development Kit Identify the kit contents Cellular service Connect the hardware Configure the device using XCTU...
  • Page 4 Add a capacitor to the RESET line Heat considerations Add a fan to provide active cooling Cellular connection process Connecting Cellular network Data network connection Data communication with remote servers (TCP/UDP) Disconnecting SMS encoding Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 5 Special commands AC (Apply Changes) FR (Force Reset) RE (Restore Defaults) WR (Write) Cellular commands PH (Phone Number) S# (ICCID) IM (IMEI) MN (Operator) MV (Modem Firmware Version) DB (Cellular Signal Strength) Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 6 SP (Sleep Period) ST (Wake Time) Command mode options CC (Command Sequence Character) CT (Command Mode Timeout) GT (Guard Times) Firmware version/information commands VR (Firmware Version) VL (Version Long) HV (Hardware Version) Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 7 Condition Solution Unresponsive cellular component in Bypass mode Condition Solution Not on expected network after APN change Condition Solution Syntax error at line 1 Solution Error Failed to send SMS Solution Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 8 Regulatory information Modification statement Interference statement Antennas FCC (USA) exposure notice ISED (Canada) exposure notice FCC Class B digital device notice Labelling requirements for the host device Digi XBee Cellular 3G Global Embedded Modem User Guide...

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

    It supports the following hardware: XBC-M5-UT-xxx Purchase the correct SIM cards The XBee Cellular Modem requires a 4FF (Nano) size SIM card. The SIM interface supports both 1.8 V and 3 V SIM types. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 10: Getting Started With The Xbee Cellular Modem Development Kit

    Connect to the Daytime server Connect to a TCP/IP address Perform a (GET) HTTP request Get started with MQTT Get started with CoAP Configure the XBee Cellular Modem using Digi Remote Manager Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 11: Identify The Kit Contents

    These features are fully supported with full-service SIMs on XBee Cellular Modem. Contact Digi at 1.877.890.4014 for SIM card support. The XBee Cellular kit includes six months of free cellular service. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 12: Connect The Hardware

    U.FL is fragile and is not designed for multiple insertions, so exercise caution when connecting or removing the antennas. We recommend using a U.FL removal tool. 4. Plug the 12 V power supply to the power jack on the development board. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 13: Configure The Device Using Xctu

    XBee Configuration and Test Utility (XCTU) is a multi-platform program that enables users to interact with 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.
  • Page 14 The XBee Java Library is a Java API. The package includes the XBee library, its source code and a collection of samples that help you develop Java applications to communicate with your XBee devices. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 15: Xbib-U-Dev Reference

    XBIB-U-DEV reference This picture shows the XBee USB development board and the table that follows explains the callouts in the picture. Number Item Description Programming header Header used to program XBee Programmable devices. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 16: Check For Cellular Registration And Connection

    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 17: Flow Control

    Set the expected transmission mode to TCP communications. DL (Destination 52.43.121.77 The target IP address of the Eliza server. Address) DE (Destination Port) 0x2328 The target port number of the Eliza server. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 18 11. Click in the left pane of the Console log, then type in the Console to talk to the ELIZA Therapist Bot. The following screenshot provides an example of this chat. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 19: Connect To The Echo Server

    1. Ensure that the 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. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 20: Connect To The Daytime Server

    Connect to the Daytime server The Daytime server reports the current Coordinated Universal Time (UTC) value responding to any user input. The following table explains the AT commands that you use in this example. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 21 For instructions on using the Console, see the AT console topic in the XCTU User Guide. 11. Click the Open button to open a serial connection to the device. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 22: Connect To A Tcp/Ip Address

    Connect the hardware. 2. Open XCTU and click the Configuration working mode button. 3. Select a device from the Radio Modules list. XCTU displays the current firmware settings for that device. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 23: Perform A (Get) Http Request

    7. To move into Transparent mode, in the AP field, select 0 and click the Write button. 8. Wait for the AI (Association Indication) value to change to 0 (Connected to the Internet). 9. Click the Consoles working mode button on the toolbar. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 24: Get Started With Mqtt

    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 pip install paho-mqtt. If you use Python 3, use pip3 install pyserial and pip3 install paho-mqtt. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 25: Example: Mqtt Connect

    9 Keep Alive MSB (0) 0X00 byte 10 Keep Alive LSB (60) 0X3C Client ID byte 11 Length MSB (0) 0x00 byte 12 Length LSB (4) 0x04 byte 13 0x44 Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 26: 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 27 11. From the AT console, click the Add new packet button in the Send packets dialog. The Add new packet dialog appears. 12. Enter the name of the data packet. Name the packet connect_frame or something similar. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 28: 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, Digi XBee Cellular 3G Global Embedded Modem User Guide...

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

    = on_connect # 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) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 30: 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 31 (len(data) == 0): print("ERROR - 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 Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 32 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 33: Get Started With Coap

    POST, PUT and DELETE methods. With these methods, the XBee Cellular Modem can transport data and requests. URI is a string of characters that identifies a resource served at the server. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 34: Coap Quick Start Example

    Delta length: 7 indicates there are 7 bytes of data following as a part of this delta option. Option value 65 78 61 6D 7 Bytes equal Example. 70 6C 65 to hex at left Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 35: Configure The Device

    This is the CoAP protocol message decomposed by bytes to perform a GET request on an example URI with a token test. 5. Click Add packet. 6. Click the Open button Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 36: 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 37: Configure The Xbee Cellular Modem Using Digi Remote Manager

    Digi Remote Manager. Note Digi is consolidating our cloud services, Digi Device Cloud and Digi Remote Manager®, under the Remote Manager name. This phased process does not affect device functionality or the functionality of the web services and other features. However, customers will find that some user interface and firmware functionality mention both Device Cloud and Digi Remote Manager.

  • Page 38: Get The Xbee Cellular Modem Imei Number

    XBee Cellular Modem supports Remote Manager firmware updates. To perform a firmware update, use the following steps. 1. Download the updated firmware file for your device from Digi's support site. This is a zip file containing .ebin and .mxi files for import. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 39 More menu. The Update Firmware dialog appears. 7. Click Browse to select the .ebin file that you unzipped earlier. 8. Click Update Firmware. The updated devices automatically reboot when the updates are complete. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 40 Use XCTU to enter the MicroPython environment Use the MicroPython Terminal in XCTU Example: hello world Example: turn on an LED Exit MicroPython mode Other terminal programs Use picocom in Linux Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 41: Get Started With Micropython

    4. To set the device's baud rate to 115200 b/s, in the BD field select 115200 [7] 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 42: 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 43: Exit Micropython Mode

    3. To turn it off, type the following and press Enter: led.value(1) You have successfully controlled an LED on the board using basic I/O! Exit MicroPython mode To exit MicroPython mode: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 44: Other Terminal Programs

    You must 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. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 45: Use Picocom In Linux

    An easy way to list these is to type: ls /dev/ttyUSB*. This produces a list of any device with a name that starts with ttyUSB. 2. Take note of the devices present with that name, and then connect the XBee Cellular Modem. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 46 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. Now you can type MicroPython commands at the >>> prompt. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 47 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 48: Technical Specifications

    Supported bands Band 19 (800 MHz) Band 5 (850 MHz) Band 8 (900 MHz) Band 2 (1900 MHz) Band 1 (2100 MHz) DO (Device Options) for more information on enabling and using the 2G fallback feature. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 49: Power Requirements

    Technical specifications Power requirements Specification Value Security Digi Trustfence™ security with secure boot, encrypted storage, protected JTAG, SSL/TLS 1.2 Downlink/uplink Up to 7.2 Mb/s / 5.76 Mb/s speeds Power requirements The following table provides the power requirements for the device.

  • Page 50: 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 51 Technical specifications Regulatory approvals Specification Value United States Contains FCC ID: XPY1CGM5NNN Industry Canada Contains IC: 8595A-1CGM5NNN Europe (CE) Pending RoHS Lead-free and RoHS compliant PTCRB certification AT&T end device certified Pending Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 52: Hardware

    Hardware Mechanical drawings Pin signals SIM card The Associate LED Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 53: Mechanical Drawings

    PWM0 / RSSI / DIO10 Either Output PWM Output 0 / RX Signal Strength Indicator / Digital I/O 10 PWM1 / DIO11 Either Disabled PWM Output 1 / Digital I/O [reserved] Do not connect Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 54: Pin Connection Recommendations

    CAUTION! Never insert or remove SIM card while the power is on! The Associate LED 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. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 55 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 56: Antenna Recommendations

    Antenna recommendations Antenna placement Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 57: Antenna Placement

    For optimal cellular reception, keep 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 58: Design Recommendations

    Design recommendations Power supply considerations Add a capacitor to the RESET line Heat considerations Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 59: Power Supply Considerations

    3.6 V during TX bursts. Add a capacitor to the RESET line In high EMI noise environments, we recommend adding a 10 nF ceramic capacitor very close to pin 5. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 60: Heat Considerations

    7. Set P1 to 1, which turns the fan on when the device gets above 70 °C and the cellular component is running, and off below 65 °C. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 61: Cellular Connection Process

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

  • Page 62: 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 or deep sleep is requested: Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 63: Sms Encoding

    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 64 Modes Select an operating mode Transparent operating mode API operating mode Bypass operating mode Command mode Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 65: Modes

    Transparent operating mode. The device queues all serial data it receives through the DIN pin for RF transmission. When a device receives RF data, it sends the data out through the DOUT pin. You can set the configuration parameters using Command mode. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 66: Api Operating Mode

    4. After rebooting, enter Command mode and verify that Bypass operating mode is active by querying AI (Association Indication) and confirming that it returns a value of 0x2F. It may take a moment for Bypass operating mode to become active. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 67: Leave Bypass Operating Mode

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

  • Page 68: Send At Commands

    WR writes parameter values to non-volatile memory so that parameter modifications persist through subsequent resets. Exit Command mode 1. Send CN (Exit Command mode) followed by a carriage return. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 69 Command mode 2. If the device does not receive any valid AT commands within the time specified by (Command Mode Timeout), it returns to the mode that the device was last in. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 70: Sleep Modes

    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 71: About Sleep Modes

    (SM = 4 or SM = 5), it starts a sleep timer (time until sleep). ST (Wake Time) to set the duration of the timer. When the sleep timer expires the device returns to sleep. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 72: 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 73: 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 74: 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 75: 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 76: At Commands

    AT commands MicroPython commands Special commands Cellular commands Network commands Addressing commands Serial interfacing commands I/O settings commands I/O sampling commands Command mode options Firmware version/information commands Diagnostic interface commands Execution commands Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 77: Micropython Commands

    A timestamp of 2000-01-01T00:00:00 indicates that the clock was not set during compilation. In API mode, PYC returns five 32-bit big-endian values: source size source hash bytecode size bytecode hash timestamp as seconds since 2000-01-01T00:00:00 Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 78: Special Commands

    If you issue FR while the device is in Command Mode, the reset effectively exits Command mode. Note We recommend entering Airplane mode before resetting or rebooting the device to allow the cellular module to detach from the network. Parameter range Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 79: Re (Restore Defaults)

    Parameter range Default Set by the cellular carrier via the SIM card S# (ICCID) Reads the Integrated Circuit Card Identifier (ICCID) of the inserted SIM. Parameter range Default Set by the SIM card Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 80: Im (Imei)

    After you set this value, applying changes with AC (Apply Changes) CN (Exit Command mode) triggers a network reset. Parameter range 1 - 100 ASCII characters Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 81: Am (Airplane Mode)

    The value only applies to subsequently opened sockets. Note Due to known vulnerabilities in prior protocol versions, we strongly recommend that you use the latest TLS version whenever possible. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 82: Tm (Tcp Client Connection Timeout)

    On each successive connection failure, the wait time doubles (60 seconds, 120, 240, and so on) up to a maximum of 1 hour. This time resets to 30 seconds once the connection to Remote Manager succeeds or if the device is reset. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 83: Eq (Device Cloud Fqdn)

    From 0 through 63 ASCII characters. Default my.devicecloud.com Addressing commands The following AT commands are addressing commands. SH (Serial Number High) The upper digits of the unique International Mobile Equipment Identity (IMEI) assigned to this device. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 84: Sl (Serial Number Low)

    011 for the United States. Range 7 - 20 ASCII digits including an optional + prefix Default DE (Destination Port) Sets or reads the destination IP port number. Parameter range 0x0 - 0xFFFF Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 85: Td (Text Delimiter)

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

  • Page 86: C0 (Source Port)

    Sets or reads the serial interface baud rate for communication between the device's serial port and the host. Parameter range 0x1 - 0xA (standard rates) 0x5B9 to 0x5B8D80 (non-standard rates up to 6 Mb/s) Parameter Description 2400 b/s 4800 b/s 9600 b/s 19200 b/s 38400 b/s Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 87: Nb (Parity)

    One stop bit 0x01 Two stop bits Default 0x00 RO (Packetization Timeout) Set or read the number of character times of inter-character silence required before transmission begins when operating in Transparent mode. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 88: Ft (Flow Control Threshold)

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

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

    DIO14/DIN pin 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) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 90: I/O Settings Commands

    Digital output, default high Default D1 (DIO1/AD1) The DIO1/AD1 pin configuration (pin 19). Parameter range 0, 2 - 5 Parameter Description Disabled Digital input Digital output, low Digital output, high Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 91: D2 (Dio2/Ad2)

    0, 2 - 5 Parameter Description Disabled Analog input Digital input Digital output, default low Digital output, default high Default D4 (DIO4) The DIO4 pin configuration (pin 11). Parameter range 0, 3 - 5 Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 92: D5 (Dio5/Associated_Indicator)

    Digital output, default low Digital output, default high Default D6 (DIO6/RTS) Sets or displays the DIO6/RTS pin 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 93: D7 (Dio7/Cts)

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

  • Page 94: D9 (Dio9/On_Sleep)

    Digital output, default high Default P0 (DIO10 Configuration) The DIO10 pin configuration. Parameter range 0, 3 - 5 Parameter Description Disabled Digital input Digital output, default low Digital output, default high Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 95: P1 (Dio11/Pwm1 Configuration)

    Parameter range 0, 3 - 5 Parameter Description Disabled Digital input Digital output, default low Digital output, default high Default I/O sampling commands The following AT commands configure I/O sampling parameters. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 96: Tp (Temperature)

    Sets or reads the time to spend asleep in cyclic sleep modes. In Cyclic sleep mode, the node sleeps with CTS disabled for the sleep time interval, then wakes for the wake time interval. Parameter range 0x1 - 0x83D600 (x 10 ms) Default 0x7530 (5 minutes) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 97: St (Wake Time)

    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) Default 0x3E8 (one second) Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 98: Firmware Version/Information Commands

    Set in firmware AI (Association Indication) 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. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 99: Hs (Hardware Series)

    Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. Parameter range 0 - 0xFFFFFFFF Default Diagnostic interface commands The following AT commands are diagnostic interface commands. DI (Device Cloud Indicator) Displays the current Remote Manager status for the XBee. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 100: Ci (Protocol/Connection Indication)

    0x10 Not registered to the cell network. 0x11 Cellular component not identified yet. 0x12 DNS query lookup failure. 0x20 Bad handle. 0x21 User closed. 0x22 Unknown server - DNS lookup failed. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 101 The following table provides the parameter's meaning when IP = 2 for SMS connections. Parameter Description 0x00 SMS successfully sent. 0x01 SMS failed to send. Invalid SMS parameters - check P# (Destination Phone Number). 0x02 0x03 SMS not supported. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 102: 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 103: Is (Force Sample)

    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 Analog chanel mask 1 byte Samples 2 bytes each Parameter range Default Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 104: Operate In Api Mode

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

  • Page 105: Api Mode Overview

    API operation (AP parameter = 1) This is the recommended API mode for most applications. The following table shows the data frame structure when you enable this mode: Frame fields Byte Description Start delimiter 0x7E Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 106: 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 0x11: XON 0x13: XOFF To escape a character: Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 107 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. Multi-byte values are sent big-endian. Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 108 FF. 01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F + B8 = 2FF Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 109: Frame Descriptions

    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 110: 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 111: 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 112: Transmit (Tx) Request: Ipv4 - 0X20

    0 - Leave the socket open (use TCP timeout) Ignore this bit for UDP packets. All other bits are reserved and should be 0. 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 113: 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 114: Transmit (Tx) Status - 0X89

    0x79 Invalid TCP port 0x7A Invalid host address 0x7B Invalid data mode 0x80 Connection refused 0x81 Socket connection lost 0x82 No server 0x83 Socket closed 0x84 Unknown server 0x85 Unknown error Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 115: Modem Status - 0X8A

    0 = Hardware reset or power up 1 = Watchdog timer reset 2 = Registered with cellular network 3 = Unregistered with cellular network 0x0E = Remote Manager connected 0x0F = Remote Manager disconnected Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 116: 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 117: Receive (Rx) Packet: Ipv4 - 0Xb0

    MSB 10 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 118: Socket Behavior

    Socket behavior Secure Sockets Layer (SSL) certificate checking Socket timeouts Enable incoming TCP sockets in API mode Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 119: Secure Sockets Layer (Ssl) Certificate Checking

    If you want to communicate back to the incoming connection, use the Transmit (TX) Request: IPv4 - 0x20 and enter the received address and port as the destination address and port, along with the listening (C0) local source port. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 120: 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 121: Cannot Find The Serial Port For The Device

    Discover radio devices list of ports. The port name that no longer appears is the correct port for the development board. Other reasons that the XBee Cellular Modem is not discoverable include: Digi XBee Cellular 3G Global Embedded Modem User Guide...
  • Page 122 2. You may not be using an updated FTDI driver. a. This may require you to reboot your computer. b. Disconnect the power and USB from the XBIB-U-DEV board and reconnect it. Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 123: 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 124: 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 125: 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 126: Regulatory Information

    Regulatory information Modification statement Interference statement Antennas FCC Class B digital device notice Labelling requirements for the host device Digi XBee Cellular 3G Global Embedded Modem User Guide...

  • Page 127: 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 128: Fcc Class B Digital Device Notice

    Contains IC: 8595A-1CGM5NNN CAN ICES-3 (B) / NMB-3 (B) This Class B digital apparatus complies with Canadian ICES-003. Cet appareil numérique de classe B est conforme à la norme canadienne ICES-003. Digi XBee Cellular 3G Global Embedded Modem User Guide...

Table of Contents