Digi XB3-C-A2-UT series User Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Modem
  5. XB3-C-A2-UT series
  6. User manual

Digi XB3-C-A2-UT series User Manual

Smart modem
Hide thumbs
Table of Contents

Advertisement

Quick Links

Digi XBee3® Cellular LTE-M
Smart Modem
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XB3-C-A2-UT series and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Digi XB3-C-A2-UT series

Summary of Contents for Digi XB3-C-A2-UT series

  • Page 1 Digi XBee3® Cellular LTE-M Smart 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: Table Of Contents

    Contents Digi XBee3 Cellular LTE-M Global Smart Modem User Guide Applicable firmware and hardware SIM cards Getting started with the XBee Smart Modem Development Kit Identify the kit contents XBIB-U-DEV reference Cellular service Connect the hardware Configure the device using XCTU...
  • Page 4 Electrical specifications Regulatory approvals Hardware Mechanical drawings Pin signals Pin connection recommendations RSSI PWM SIM card The Associate LED Antenna recommendations Antenna placement Design recommendations Power supply considerations Minimum connection diagram Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 5 Cyclic sleep with pin wake up mode Airplane mode SPI mode and sleep pin functionality The sleep timer MicroPython sleep behavior Serial communication Serial interface Serial data UART data flow Serial buffers CTS flow control Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 6 DE (Destination Port) C0 (Source Port) LA (Lookup IP Address of FQDN) Serial interfacing commands BD (Baud Rate) NB (Parity) SB (Stop Bits) RO (Packetization Timeout) TD (Text Delimiter) FT (Flow Control Threshold) Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 7 API frame format API operation (AP parameter = 1) API operation with escaped characters (AP parameter = 2) Frame descriptions AT Command - 0x08 AT Command: Queue Parameter Value - 0x09 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 8 Solution Network connection issues Condition Solution Set the APN value Regulatory information United States (FCC) OEM labeling requirements FCC notices FCC-approved antennas RF exposure IC (Industry Canada) Labeling requirements RF Exposure Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 9: Digi Xbee3 Cellular Lte-M Global Smart Modem User Guide

    Reduced hardware complexity with only 1 antenna required Integrated MicroPython programmability enables custom scripting directly on the modem Enhanced with Digi TrustFence™ security framework Manage and configure with XCTU and Digi Remote Manager® Available with Digi provided SIM cards and data plans Applicable firmware and hardware...

  • Page 10: Getting Started With The Xbee Smart 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 Smart Modem using Digi Remote Manager Software libraries Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 11: Identify The Kit Contents

    One 12 V power supply One cellular antenna with U.FL connector One Bluetooth Low Energy (BLE) antenna (BLE support is forthcoming but not currently available) One USB cable One XBee Smart Modem One SIM card Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 12: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 13: Cellular Service

    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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 14: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 15: 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 16: Check For Cellular Registration And Connection

    The Update firmware dialog displays the available and compatible firmware for the selected XBee module. 4. Select the product family of the XBee module, the function set, and the latest firmware version. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 17 5. Click Update. A dialog displays update progress. Click Show details for details of the firmware update process. How to update the firmware of your modules in the XCTU User Guide for more information. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 18: Send An Sms Message To A Phone

    7. In the TD field, type D and click the Write button. 8. Note the number in the PH field; it is the XBee Smart Modem phone number, which you see when it sends an SMS to your phone. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 19: Debugging

    Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 20: Connect To The Eliza Server

    10. 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 21: Debugging

    Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 22: Connect To The Echo Server

    7. To enter the destination address of the echo server, in the DL field, type 52.43.121.77 and click the Write button. 8. To enter the destination IP port number, in the DE field, type 2329 and click the Write button. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 23: Debugging

    Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 24: Connect To The Daytime Server

    9. Click the Consoles working mode button on the toolbar to open a serial console to the device. For instructions on using the Console, see the AT console topic in the XCTU User Guide. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 25: Debugging

    Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 26: Connect To A Tcp/Ip Address

    8. Exit Command mode; see Exit Command mode. 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. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 27: Debugging

    Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 28: Perform A (Get) Http Request

    2E 6F 72 67 0D 0A 0D 0A Note 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 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 29: Debugging

    Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 30: Get Started With Mqtt

    The following table is an example connect packet: Description Hex value CONNECT packet fixed header byte 1 Control packet type 0x10 byte 2 Remaining length 0x10 CONNECT packet variable header Protocol name Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 31 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 32: 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 33 15. Click the packet in the Send packets list. 16. Click Send selected packet. 17. A CONNACK packet response from the broker appears in the Console log. This is a connection acknowledgment; a successful response should look like this: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

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

    “digitest/test1”, receive any messages published on it def on_message(client, userdata, msg): # The callback for when a PUBLISH message is received from the server. print("Message received-> " + msg.topic + " " + str(msg.payload)) # Print a Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

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

    XCTU as described in Example: MQTT connect. 4. You can make the proxy with a dual-threaded Python script, a simple version follows: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 36 ('ser') to the modem for transmission. """ global clisock while (1): data = clisock.recv(4096) # RX data from client socket Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 37 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 Smart Modem. The following figure shows the basic operation. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 38 To avoid these errors, it is best to start the scripts in the correct order: proxy, then subscribe, then publish. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 39: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 40: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

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

    HTTP protocol and how to do this using the XBee Smart Modem. In this example, the XBee Smart 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 Smart Modem to talk to the remote CoAP server.
  • Page 42 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 43 Getting started with the XBee Smart Modem Development Kit Get started with CoAP Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 44: Configure The Xbee Smart 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 45: Update The Firmware

    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 XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 46 Use XCTU to enter the MicroPython environment Use the MicroPython Terminal in XCTU Example: hello world Example: turn on an LED Example: code a request help button Exit MicroPython mode Other terminal programs Use picocom in Linux Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 47: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 48: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 49: Example: Code A Request Help Button

    This example provides a fast, deep dive into MicroPython designed to let you see some of the powerful things it can do with minimal code. It is not meant as a tutorial; for in-depth examples refer to the Digi MicroPython Programming Guide. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 50: Enter Micropython Paste Mode

    Many stores have help buttons in their aisles that a customer can press to alert the store staff that assistance is required in that aisle. You can implement this type of system using the Digi XBee Smart Modem, and this example provides the building blocks for such a system. This example, based on SMS...
  • Page 51 You can easily copy and paste code from the online version of this Guide. Use caution with the PDF version, as it may not maintain essential indentations. Note If you have problems pasting the code, see Syntax error at line Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 52: Send A Text (Sms) When The Button Is Pressed

    PDF version, as it may not maintain essential indentations. Note If you have problems pasting the code, see Syntax error at line 1. For SMS failures, see Error Failed to send SMS. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 53: Add The Time The Button Was Pressed

    # Send message to the given number. Handle error if it occurs. try: c.sms_send(ph, 'Button Pressed at: ' + str(buf)) print("Sent SMS successfully.") except OSError: print("ERROR- failed to send SMS.") # Exit the WHILE loop. break Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 54: Exit Micropython Mode

    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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 55: Use Picocom In Linux

    With the XBee Smart Modem in MicroPython mode (AP = 4), you can access the MicroPython prompt using a terminal. Note The user must have read and write permission for the serial port the XBee Smart Modem is connected to in order to communicate with the device. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 56 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 57: Technical Specifications

    Technical specifications Interface and hardware specifications Cellular RF characteristics Bluetooth RF characteristics Cellular Networking specifications Power requirements Power consumption Electrical specifications Regulatory approvals Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 58: Interface And Hardware Specifications

    Receive sensitivity, 2 Mb/s data rate -90 dBm Operating frequency band ISM 2.4 - 2.4835 GHz Cellular Networking specifications The following table provides the networking and carrier specifications for the device. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 59: Power Requirements

    20 µA Deep sleep current 10 µA Electrical specifications The following table provides the electrical specifications for the XBee Smart Modem. Symbol Parameter Condition Typical Units VCCMAX Maximum limits of VCC line Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 60: Regulatory Approvals

    The following table provides the regulatory and carrier approvals for the device. Specification Value FCC ID: MCQ-XB3M1 United States FCC ID: XPY2AGQN4NNN IC: 1846A-XB3M1 Industry Canada IC: 8595A-2AGQN4NNN RoHS Lead-free and RoHS compliant AT&T end-device certified Complete PTCRB Complete Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 61: Hardware

    Hardware Mechanical drawings Pin signals RSSI PWM SIM card The Associate LED Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 62: Mechanical Drawings

    Hardware Mechanical drawings Mechanical drawings The following figures show the mechanical drawings for the XBee Smart Modem. All dimensions are in inches. Pin signals The pin locations are: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 63 Either Disabled Analog Input 3 or Digital I/O 3, SPI low enabled select line The XBee3 device is 5 V tolerant on this pin whereas most other XBee devices are not. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 64: Pin Connection Recommendations

    Less than -103 dBm, or no cellular network Less than connection 45.45% SIM card The XBee Smart Modem uses a 4FF (Nano) size SIM card. CAUTION! Never insert or remove SIM card while the power is on! Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 65: The Associate Led

    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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 66: Antenna Recommendations

    Antenna recommendations Antenna placement Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 67: Antenna Placement

    For optimal cellular reception, keep the antenna as far away from metal objects and other electronics (including the XBee Smart Modem) as possible. Often, small antennas are desirable, but come at the cost of reduced range and efficiency. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 68 Design recommendations Power supply considerations Minimum connection diagram Heat considerations and testing Heat sink guidelines Add a fan to provide active cooling Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 69: Design Recommendations

    XBee Smart Modem is going into and mitigate heat issues if necessary. We recommend that you perform thermal testing in your application to determine the resulting steady state temperature of the XBee Smart Modem. Use TP (Temperature) to estimate the device Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 70 15 - 20 minutes. Power the device and immediately read the TP command. Convert the TP reading from hex format to decimal and subtract the result from the actual room temperature. Add this offset to to T in your XBee numbers above. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 71: Heat Sink Guidelines

    The heat sink should be no more than 8x8 mm in size (one option is the Assman WSW Components V2016B). Use a thermally conductive epoxy to Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 72: Add A Fan To Provide Active Cooling

    P1 (DIO11/PWM1 Configuration) to 1. Note that the I/O pin is not capable of driving a fan directly; you must implement a circuit to power the fan from a suitable power source. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 73 Cellular connection process Connecting Cellular network Data network connection Data communication with remote servers (TCP/UDP) Disconnecting Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 74: Connecting

    3. The cellular network may also close the connection after a timeout set by the network operator. Disconnecting When the XBee Smart Modem is put into Airplane mode or deep sleep is requested: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 75 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 76: Modes

    Modes Select an operating mode Transparent operating mode API operating mode Bypass operating mode USB direct mode Command mode Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 77: Select An Operating Mode

    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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 78: Transparent Operating Mode

    API mode. Command mode is available while in Bypass mode; see Enter Command mode for instructions. Enter Bypass operating mode To configure a device for Bypass operating mode: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 79: Leave Bypass Operating Mode

    6, it overrides the behavior of DO bit 2. You must reset the device to enable or disable USB direct mode. While in USB direct mode, AI (Association Indication) returns 0x2B. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 80: Enable The Vbus Option

    Failure to enter Command mode is often due to baud rate mismatch. Ensure that the baud rate of the connection matches the baud rate of the device. By default, the BD parameter = 3 (9600 b/s). There are two alternative ways to enter Command mode: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 81: Send At Commands

    2. Exit Command mode. Make command changes permanent Issue a WR command command to save the changes. WR writes parameter values to non-volatile memory so that parameter modifications persist through subsequent resets. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 82: Exit 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 83: Sleep Modes

    About sleep modes Normal mode Pin sleep mode Cyclic sleep mode Cyclic sleep with pin wake up mode Airplane mode SPI mode and sleep pin functionality The sleep timer MicroPython sleep behavior Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 84: About Sleep Modes

    However, if SLEEP_RQ is not configured as a peripheral and SPI_SSEL is configured as a peripheral, then pin sleep is controlled by SPI_SSEL rather than by SLEEP_RQ. Asserting SPI_SSEL by driving it low Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 85: The Sleep Timer

    As a result, any sockets that were opened in MicroPython prior to sleep report as no longer being connected. This behavior appears the same as a typical socket disconnection event will: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 86 (b'', (<address from connect()>, <port from connect()>) ) The underlying UDP socket resources have been released at this point. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 87: Serial Communication

    Serial communication Serial interface Serial data UART data flow Serial buffers CTS flow control RTS flow control Enable UART or SPI ports Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 88: Serial Interface

    Devices that have a UART interface connect directly to the pins of the XBee Smart 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 89: Serial Buffers

    If you change the configuration so that only one port is configured, then that port is the only one enabled or used. If the parameters are written with only one port enabled, then the port that is not enabled is not used even temporarily after the next reset. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 90 Enable UART or SPI ports If both ports are disabled on reset, the device uses the UART in spite of the wrong configuration so that at least one serial port is operational. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 91: Spi Operation

    SPI operation SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Data format Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 92: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 93: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 94: 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 95: Force Uart Operation

    (0x7E) cannot be included in the invalid data as this would cause the receiver to begin parsing a new frame. But, in reality the XBee Smart Modem sends 0XFF for invalid characters and the S8 and S6 products may send all ones or all zeros. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 96: At Commands

    AT commands Special commands Cellular commands Network commands Addressing commands Serial interfacing commands I/O settings commands I/O sampling commands Sleep commands Command mode options MicroPython commands Firmware version/information commands Execution commands Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 97: Special Commands

    (Write) command after issuing the RE command to save restored parameter values to non-volatile memory. Parameter range Default WR command Writes parameter values to non-volatile memory so that parameter modifications persist through subsequent resets. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 98: Cellular Commands

    IM (IMEI) Reads the device's International Mobile Equipment Identity (IMEI). Parameter range Default Set in the factory MN (Operator) Reads the network operator on which the device is registered. Parameter range Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 99: Mv (Modem Firmware Version)

    When set, the cellular component of the XBee Smart Modem is fully turned off and no access to the cellular network is performed or possible. Parameter range 0 - 1 0 = Normal operation 1 = Airplane mode Default Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 100: Network Commands

    The IP client connection timeout. If there is no activity for this timeout then the connection is closed. If TM is 0, the connection is closed immediately after the device sends data. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 101: Ts (Ip Server Connection Timeout)

    FR (Force Reset) to reset the device. Note Setting P0 (DIO10/PWM0 Configuration) to 6 overrides setting DO bit 2. Range 0x00 - 0x07 The supported states of DO are: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 102: Eq (Device Cloud Fqdn)

    The lower digits of the unique International Mobile Equipment Identity (IMEI) assigned to this device. Parameter range 0 - 0xFFFFFFFF [read-only] Default MY (Module IP Address) Reads the device's IP address. This command is read-only because the IP address is assigned by the mobile network. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 103: P# (Destination Phone Number)

    DL (Destination Address) The destination IPv4 address or fully qualified domain name. To set the destination address to an IP address, the value must be a dotted quad, for example XXX.XXX.XXX.XXX. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 104: Od (Operating Destination Address)

    UART is in Transparent or API mode. For more information on using incoming connections, see Socket behavior. Parameter range 0 - 0xFFFF Value Description Disabled Non-0 Enabled on that port Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 105: La (Lookup Ip Address Of Fqdn)

    Non-standard baud rates: 0x5B9 to 0x3D090 (250,000 b/s) Parameter Description 1200 b/s 2400 b/s 4800 b/s 9600 b/s 19200 b/s 38400 b/s 57600 b/s 115200 b/s 230400 b/s Default 0x3 (9600 b/s) Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 106: Nb (Parity)

    Set RO to 0 to transmit characters as they arrive instead of buffering them into one RF packet. Set to FF for realtime typing by humans. Also, see TD (Text Delimiter). Parameter range 0 - 0xFF (x character times) Default Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 107: Td (Text Delimiter)

    API disabled (operate in Transparent mode) 0x01 API enabled 0x02 API enabled (with escaped control characters) 0x03 0x04 MicroPython REPL 0x05 Bypass mode Default I/O settings commands The following AT commands are I/O settings commands. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 108: D0 (Dio0/Ad0)

    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 D2 (DIO2/AD2) Sets or displays the DIO2/AD2 configuration (pin 18). Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 109: D3 (Dio3/Ad3)

    Sets or displays the DIO3/AD3 configuration (pin 17). Parameter range 0 - 5 Parameter Description Disabled SPI_SSEL Analog input Digital input Digital output, default low Digital output, default high Default D4 (DIO4) Parameter range Default Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 110: D5 (Dio5/Associated_Indicator)

    RTS flow control Digital input Digital output, default low Digital output, default high Default D7 (DIO7/CTS) Sets or displays the DIO7/CTS configuration (pin 12). Parameter range 0, 1, 3 - 5 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 111: D8 (Dio8/Sleep_Request)

    Default Sets or displays the DIO9/ON_SLEEP configuration (pin 13). Parameter range 0, 1, 3 - 5 Parameter Description Disabled ON/SLEEP output Digital input Digital output, default low Digital output, default high Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 112: P0 (Dio10/Pwm0 Configuration)

    Airplane Mode Digital input Digital output, default low Digital output, default high I2C SDA USB direct Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 113: P2 (Dio12 Configuration)

    Sets or displays the DIO13/DOUT configuration (pin 17). Parameter range 0, 1 Parameter Description Disabled UART DOUT enabled Default P4 (DIO14/DIN) Sets or displays the DIO14/DIN configuration (pin 3). Parameter range 0 - 1 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 114: Pd (Pull Direction)

    The following table defines the bit-field map for both the PR and PD commands. I/O line Module pin DIO4 pin 11 DIO3/AD3 pin 17 DIO2/AD2 pin 18 DIO1/AD1 pin 19 DIO0/AD0 pin 20 DIO6/RTS pin 16 DIO8/SLEEP_REQUEST pin 9 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 115: M0 (Pwm0 Duty Cycle)

    8-bit two’s compliment format. For example, 0x1A = 26 °C, and 0xF6 = -10 °C. Parameter range 0 - 0xFF which indicates degrees Celsius displayed in 8-bit two's compliment format. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 116: Sleep Commands

    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) ST (Wake Time) Sets or displays the time to spend awake in cyclic sleep modes. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 117: Command Mode Options

    Command mode sequence (GT + CC + GT). The period of silence prevents inadvertently entering Command mode. Parameter range 0x2 - 0x6D3 (x 1 ms) Default 0x3E8 (one second) MicroPython commands The following commands relate to using MicroPython on the XBee Smart Modem. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 118: Ps (Python Startup)

    2000-01-01T00:00:00 PYD (Delete Code) PYD interrupts any running code, erases any stored code and then does a soft-reboot on the MicroPython subsystem. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 119: Firmware Version/Information Commands

    Parameter range 0 - 0xFFFF [read-only] Default 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. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 120: Di (Device Cloud Indicator)

    CI (Protocol/Connection Indication) Displays information regarding the last IP connection (when the IP command = 0 or 1). The following table provides the parameter's meaning when IP = 0 for UDP connections. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 121 Bad handle. 0x21 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. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 122: Hs (Hardware Series)

    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 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 123: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 124 Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Frame descriptions Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 125: Operate In Api Mode

    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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 126: 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 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 127 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 128 FF. 01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F + B8 = 2FF Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 129: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 130: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

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

    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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 132: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 133: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 134: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

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

    The XBee Smart Modem uses this frame when it receives RF data on a network socket that is created by a TX request frame or configuring C0 (Source Port). Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 136 API mode behavior for incoming UDP data Transparent mode behavior for outgoing TCP and SSL connections Transparent mode behavior for outgoing UDP data Transparent mode behavior for incoming TCP connections Transparent mode behavior for incoming UDP connections Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 137: Socket Behavior

    0. 1 TCP socket is used for Remote Manager, so if you have Remote Manager enabled, subtract 1 socket from the values above. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 138: Api Mode Behavior For Outgoing Udp Data

    To send data from the device over the connection, use the Transmit (TX) Request: IPv4 - 0x20 frame with the corresponding address fields received from the Receive RX frame. In other words: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 139: Api Mode Behavior For Incoming Udp Data

    To send outgoing UDP data to a remote host, send data to the XBee Smart Modem's serial port. If (Protocol/Connection Indication) reports a value of 0, the data was successfully sent; otherwise, the value of CI indicates why the data failed to be sent. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 140: Transparent Mode Behavior For Incoming Tcp Connections

    Any data sent to the XBee Smart 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 Smart Modem discards data sent to the serial port. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 141: Troubleshooting

    This section contains troubleshooting steps for the XBee Smart Modem. Cannot find the serial port for the device Correct a macOS Java error Unresponsive cellular component in Bypass mode Syntax error at line 1 Network connection issues Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 142: 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 Smart Modem is not discoverable include: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 143 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 144: 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 XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 145: Unresponsive Cellular Component In Bypass Mode

    Bypass operating mode. To check and set the currently active APN string you must perform the following steps: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 146 Troubleshooting Network connection issues Enter Bypass operating mode. 2. Type at+cgdcont=1,"IP","<APN String>" and press Enter. For example for this early adopter kit: at+cgdcont=1,"IP","vzwinternet" Leave Bypass operating mode. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 147: Regulatory Information

    Regulatory information United States (FCC) IC (Industry Canada) Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

  • Page 148: United States (Fcc)

    FCC notices IMPORTANT: XBee3 RF Modules have been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091). Modifications not expressly approved by Digi could void the user's authority to operate the equipment.

  • Page 149: Fcc-Approved Antennas

    If the antenna is mounted at least 20 cm (7.87 in) from nearby persons, the application is considered a mobile application. The antennas below have been approved for use with this module. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas.

  • Page 150: Rf Exposure

    Antenne(s) utilisé pour cet émetteur doit être installé pour fournir une distance de séparation d'au moins 20 cm à partir de toutes les personnes et ne doit pas être situé ou fonctionner en conjonction avec tout autre antenne ou émetteur. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
  • Page 151 Canada. Dans le but de réduire les risques de brouillageradioélectrique à l'intention des autres utilisateurs, il faut choisir le type d'antenne etson gain de sorte que la puissance isotrope rayonnée équivalente (p.i.r.e.) ne dépassepas l'intensité nécessaire àl'établissement d'une communication satisfaisante. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...

This manual is also suitable for:

Xbee3 cellular lte-m

Table of Contents