1. Manuals
  2. Brands
  3. Digi Manuals
  4. Modem
  5. XBee 3 Cellular LTE-M
  6. User manual

Digi XBee 3 Cellular LTE-M User Manual

Smart modem
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Digi XBee® 3 Cellular LTE-M/NB-IoT
Smart Modem
User Guide

Advertisement

Table of Contents
loading

Related Manuals for Digi XBee 3 Cellular LTE-M

Summary of Contents for Digi XBee 3 Cellular LTE-M

  • Page 1 Digi XBee® 3 Cellular LTE-M/NB-IoT 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 To provide feedback on this document, email your comments to techcomm@digi.com Include the document title and part number (Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide, 90002258 W) in the subject line of your email. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 4: Table Of Contents

    Contents Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide Applicable firmware and hardware SIM cards NB-IoT network Get started with the XBee Smart Modem Identify the kit contents Determine cellular service and acquire a SIM card US customers European customers...
  • Page 5 Configure XBee settings within Remote Manager Examples: IOT protocols with transparent mode Get started with CoAP CoAP terms CoAP quick start example Configure the device Example: manually perform a CoAP request Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 6 Pin signals Pin connection recommendations XBee header connector requirements RSSI PWM SIM card Associate LED functionality Development boards XBIB-CU-TH reference XBIB-C-GPS reference Interface with the XBIB-C-GPS module Antenna recommendations Antenna placement Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 7 USB direct mode Connect the hardware for USB Direct mode Configure the data pins Enable USB direct mode Configure and use PPP with a Digi XBee 3 Cellular LTE-M/NB-IoT modem Bypass operating mode (DEPRECATED) Enter Bypass operating mode Leave Bypass operating mode...
  • Page 8 Secure files XCTU interface Encrypt files Socket behavior Supported sockets Best practices when using sockets Sockets and Remote Manager Sockets and API mode Socket timeouts Socket limits in API mode Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 9 Receive a Socket Status indicating closed connection Transport Layer Security (TLS) Specifying TLS keys and certificates Transparent mode and TLS API mode and TLS Key formats Certificate formats Certificate limitations Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 10 DX (Requested eDRX cycle length) D? (Network-provided eDRX cycle length) PG (Ping) Addressing commands SH (Serial Number High) SL (Serial Number Low) MY (Module IP Address) P# (Destination Phone Number) N1 (DNS Address) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 11 CC (Command Sequence Character) CT (Command Mode Timeout) CN (Exit Command mode) GT (Guard Times) MicroPython commands PS (Python Startup) PY (MicroPython Command) Firmware version/information commands VR (Firmware Version) VL (Verbose Firmware Version) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 12 ER (Remote Manager TCP Port Override) ES (Remote Manager UDP Port Override) MT (Remote Manager Idle Timeout) System commands KL (Device Location) KP (Device Description) KC (Contact Information) Socket commands SI (Socket Info) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 13 Socket Receive - 0xCD Socket Receive From: IPv4 - 0xCE Socket Status - 0xCF File system API frames Local File System Request - 0x3B File Open - 0x01 File Close - 0x02 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 14 Correct a macOS Java error Condition Solution Unresponsive cellular component in Bypass mode Condition Solution Syntax error at line 1 Solution Error Failed to send SMS Solution Network connection issues Condition Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 15 Labeling requirements RF Exposure Mexico (IFETEL) OEM labeling requirements Brazil (ANATEL) Deprecated kit (PN XK3-C-A2-UT-U or XK3-C-N1-UT-E) Identify the kit contents Connect the hardware XBIB-U-DEV reference Example: turn on an LED Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 16 AT commands for managing run-time behavior Low power modes LTE power save mode (PSM) Deep sleep mode Pin sleep support Cyclic sleep support Airplane mode support Digi TrustFence secure boot Multi-network capability (Verizon, AT&T) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 17: Applicable Firmware And Hardware

    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 18: Get Started With The Xbee Smart 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 19: Identify The Kit Contents

    This cable is used only with USB Direct mode. Do not use this cable to power the development board. One XBee Smart Modem Note The XBee Smart Modem comes attached to the board in ESD wrap. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 20 NB-IoT kits do not include a SIM card. Contact your NB-IoT mobile carrier provider to obtain a SIM card and service. See Determine cellular service and acquire a SIM card. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 21: Determine Cellular Service And Acquire A Sim Card

    If your kit does not include a SIM card, the following sections below explain how to purchase a SIM card in the US and Europe. US customers In the US, Digi XBee® 3 Cellular LTE-M/NB-IoT works with AT&T, Verizon, and T-Mobile. You must purchase a SIM card before you can connect the hardware. Contact Digi Sales at www.digi.com/contactus for information about obtaining a SIM card and activating cellular service.

  • Page 22: Connect The Hardware

    Note Some kits do not include a SIM card. Contact your mobile carrier provider to obtain a SIM card and service. See Determine cellular service and acquire a SIM card. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 23: 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 24: Update The Device And Cellular Firmware Using Xctu

    SIM card. See Determine cellular service and acquire a SIM card. 5. To set the APN, in the AN field, type the APN value from your carrier and click the Write button Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 25: European Customers

    If the carrier makes a change to the service, reset the module and wait 5-6 minutes. If the carrier does not make a change to the service, then contact Digi support. Check for cellular registration and connection The cellular network registration and address assignment must occur successfully. To verify the network connection, you can view the LED on the development board or check the status of the relevant commands in XCTU.
  • Page 26 IP address. If it reads 0.0.0.0, it has not registered yet. Hints To search for an AT command in XCTU, use the search box To read a command's value, click the Read button next to the command. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 27 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 28: Xbee Connection Examples

    TCP echo Port) server. This port in decimal is 9001. UDP: The target port 2711 (0x2711) number of the UDP echo server. This port in decimal is 10001. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 29 11. Click in the left pane of the Console log, then type in the Console to talk to the echo server. The following screenshot provides an example of this chat. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 30: 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 with the user's text in blue. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 31 XBee connection examples Connect to the ELIZA server Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 32: Connect To The Daytime Server

    7. To enter the destination IP port number, in the DE field, type 232A and click the Write button. 8. To disable text delimiter checking, in the TD field, type 0 and click the Write button. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 33 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 34: Perform A (Get) Http Request

    The HTTP protocol requires an empty line (a line with nothing preceding the CRLF) to terminate the request. 14. Click Add packet. 15. Click the Open button 16. Click Send selected packet. 17. A GET HTTP response from httpbin.org appears in the Console log. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 35: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 36: Software Libraries

    Python and facilitates the development of these types of applications, making it an easy process. The XBee ANSI C Library project is a collection of portable ANSI C code for communicating with the devices in API mode. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 37 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 38: Get Started With Micropython

    . We recommend using flow control to avoid data loss, especially when pasting large amounts of code/text. 5. Put the XBee Smart Modem into MicroPython mode, in the AP field select MicroPython REPL [4] and click the Write button Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 39: Use The Micropython Terminal In Xctu

    This example is only for kits that use the XBIB-CU-TH development board. For an example that uses the XBIB-U-DEV development board, see Example: turn on an LED. Other terminal programs if you do not use the MicroPython Terminal in XCTU. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 40: 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. from machine import UART import sys, time def uart_init(): u = UART(1) u.write('Testing from XBee\n') return u def uart_relay(u): while True: uart_data = u.read(-1) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 41: Exit Micropython Mode

    4. Click OK. The COMxx - Tera Term VT terminal window appears and Tera Term attempts to connect to the device at a baud rate of 9600 b/s. The terminal will not allow communication Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 42: Use Picocom In Linux

    Now you can type MicroPython commands at the >>> prompt. Use picocom in Linux With the XBee Smart Modem in MicroPython mode (AP = 4), you can access the MicroPython prompt using a terminal. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 43 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 44: Get Started With Ble

    (client) device. If your device is updated to the most recent firmware, BLE enables you to connect your XBee (client) to another (server) device. The latest Digi XBee products include a dual- mode radio that allows the device to communicate through the BLE interface and the RF/Cellular network at the same time.

  • Page 45: On Xbee 3 Cellular Firmware Ending In X14 Or Older

    Before you begin, you should determine the password you want to use for BLE on the XBee device and store it in a secure place. Digi recommends a secure password of at least 8 characters and a random combination of letters, numbers, and special characters. Digi also recommends using a security management tool such as LastPass or Keepass for generating and storing passwords for many devices.

  • Page 46: Get The Digi Xbee Mobile Phone Application

    8. Click OK to save the configuration. Get the Digi XBee Mobile phone application To see the nearby devices that have BLE enabled, you must get the free Digi XBee Mobile application from the iOS App Store or Google Play and downloaded to your phone.

  • Page 47: Connect With Ble And Configure Your Xbee Device

    Get started with BLE Connect with BLE and configure your XBee device Connect with BLE and configure your XBee device You can use the Digi XBee Mobile application to verify that BLE is enabled on your XBee device. Get the Digi XBee Mobile phone application.

  • Page 48: Api Request Characteristic

    Response data will be presented through indications on this characteristic. Indications are acknowledged and re-transmitted at the BLE link layer and application layer and provides a robust transport for this data. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 49: 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. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP.

  • Page 50: Create A Remote Manager Account

    Guide, available via the Documentation tab in Remote Manager. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. Before you can manage an XBee with Remote Manager, you must create a Remote Manager account.

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

    Update your security certificates Perform a data service device request Send an SMS message to your device Scheduled tasks can be created and performed through the following methods: Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 52: Overview: Create A Schedule For A Set Of Tasks

    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 53: Example: Configure A Device From Remote Manager Using Xml

    Example: Configure a device from Remote Manager using XML You can configure each XBee device from Remote Manager, using XML. The devices must be in the Remote Manager inventory device list and be active. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    Update firmware. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. In this configuration example, you are changing the device to poll four times a day instead of just once. In this case, you should change the DF parameter to 360 minutes.
  • Page 55 Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 Cellular LTE-M/NB-IoT Gating Firmware to download the zip file. If you have already upgraded past the gating firmware, click XBee Cellular LTE- M/NB-IoT Firmware to download the zip file.

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

    You must upgrade your device to the latest firmware for all features to be available. See Update firmware. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. Step 1: Upload the MicroPython files Log into Remote Manager.
  • Page 57 <!-- Reboot to stop MicroPython --> <name>Reboot</name> <event> <on_error> <continue/> </on_error> </event> <sci> <reboot allowOffline="true" waitForReconnect="true"/> </sci> </command> <!-- Update MicroPython application--> <command> <name>Upload Files</name> <event> <on_error> <continue/> </on_error> </event> Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 58 <set_setting> <micropython> <PS>1</PS> </micropython> <remote_manager> <MO>6</MO> </remote_manager> </set_setting> </rci_request> </send_message> </sci> </command> <!-- Reboot to start the program --> <command> <name>Reboot</name> <event> <on_error> <end_task/> </on_error> </event> <sci> <reboot allowOffline="true" waitForReconnect="false"/> Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 59: Manage Data In Remote Manager

    Manage data in Remote Manager You can view and manage XBee data in Remote Manager. You can also update your device firmware from Remote Manager. See Update the device firmware. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 60: Review Device Status Information From Remote Manager

    Remote Manager. The device must be in the Remote Manager inventory device list and be active. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. 1. Set up a persistent connection to connect the device to Remote Manager using one of the following methods: Remote Manager: A persistent connection can be set up in Remote Manager.

  • Page 61: Remote Manager Reference

    You can use the SM/UDP feature to leverage the very small data footprint of Remote Manager SM protocol over UDP. Note Battery Operated Mode may be enabled in Digi Remote Manager. Review the Battery Operated Mode section to determine the impact of enabling this mode on SM/UDP.

  • Page 62: Tcp Connection

    To set up a scheduled operation to maintain a persistent connection: Log into Remote Manager. 2. Make sure that you have enabled SM/UDP. See Enable SM/UDP. 3. Click Device Management > Schedules. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 63: Disconnect

    Guide. Configure XBee settings within Remote Manager You can configure the device settings to use features with Remote Manager. For more information, Example: Read settings and state using Remote Manager. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 64 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 65 (international) code, you can re-configure the device using the DP (Remote Manager Phone Number) RI (Remote Manager Service ID) commands. 10. Click Save. 11. When all changes are complete, disconnect the device from Remote Manager. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 66: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 67: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 68: Configure The Device

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 69: 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 70 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 71: 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 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 72 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 73: 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 74: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 75: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    """ This function sets up the variables needed, including the serial port, and it's speed/port settings, listening socket, and localhost adddress. """ Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 77 - 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 78 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 XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 79 To avoid these errors, it is best to start the scripts in the correct order: proxy, then subscribe, then publish. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 80 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 and cellular component firmware updates.

  • Page 81: Update The Firmware

    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: Always test device and any cellular component firmware updates before deploying these updates to units in the field.

  • Page 82: Update The Device And The Cellular Firmware Using Xctu

    The device is added to XCTU. See Add a device to XCTU. Digi XBIB-CU-TH development board, or your own hardware which enables USB Direct access USB cable for USB Direct access is connected to the PC Cellular component USB drivers are installed To update the device and cellular firmware: 1.
  • Page 83 XCTU applies and updates the device firmware. If the cellular firmware is being updated, XCTU reconfigures the XBee for USB Direct access and updates the new cellular firmware on the device. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 84: 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 85: Update The Firmware Using Web Services In Remote Manager

    Update the firmware Update the device firmware c. Locate and click Digi XBee 3 Cellular LTE-M/NB-IoT Gating Firmware to download the zip file. d. Unzip the file. The file contains either a .ebin or a .gbl file. 2. Set up a persistent connection to connect the device to Remote Manager. See...
  • Page 86 This zip file contains the firmware image. 2. Unzip the file and locate the .gbl file inside the unzipped directory. 3. Log in to Remote Manager. 4. Click the Data Services tab. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 87 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 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 88 ATHS, little endian. CCCCCCCCCCCCCCCC: The serial number. 5. If possible, change the baud rate of the serial port to optimize the firmware update process. Send the X command to the bootloader. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 89 The argument is the value of SL added to the value 0xDB8A and then masked by performing a bitwise-AND with 0x3FFF. For example: i. Run ATSL to get the address value, which is in hex. ATSL 123456 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 90 A power cycle or reset event occurs during the firmware load. A file error or a flash error occurs during the firmware load. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 91: Update The Cellular Firmware

    An example script is included in this section. Prerequisites You will need a list of the IMEI values for all XBee 3 Cellular LTE-M/NB-IoT modules to be updated. Each module must be running firmware 11413 or later. For update instructions, see...
  • Page 92 FTP server and the script attempts to apply the appropriate update files based on intelligence built into the script. The optional arguments should only rarely need to be changed and generally only if the Digi FTP server is not accessible on a private APN, or by direction of Digi Technical Support.

  • Page 93: Update An Xbee Module Cellular Component Using Api Mode (Over The Wire)

    Update an XBee module cellular component using API mode (over the wire) You can update an XBee 3 Cellular LTE-M/NB-IoT module from the current module cellular component version to a more recent version over the wire, using API mode and the script described in this section.
  • Page 94 FTP server and the script attempts to apply the appropriate update files based on intelligence built into the script. The optional arguments should only rarely need to be changed and generally only if the Digi FTP server is not accessible on a private APN, or by direction of Digi Technical Support.
  • Page 95 -f FILE, --file FILE Apply only this one file (default: None) Other arguments: -v, --verbose Also emit log messages about communications with the XBee (default: False) For additional help, see the XBee 3 Cellular LTE-M/NB-IoT user guide or contact Digi Technical Support at <tech.support@digi.com>. Example Examples of usage: C:\Users\admin\over-the- wire>C:\Users\admin\AppData\Local\Programs\Python\Python37-32\python.exe...

  • Page 96: Update The Cellular Module From A Pc Using The Easyflash Firmware Update

    How the script works. 9. When complete, a digi-update.log text file is created, which contains a copy of the log messages emitted to the terminal while the script was running. 10. A successful update appears as: 2019-06-27 16:06:28,479 update.py: INFO: Reading cellular component version string (ATMV)...
  • Page 97 Technical specifications Interface and hardware specifications Cellular RF characteristics Bluetooth RF characteristics Cellular networking specifications Power requirements Power consumption Electrical specifications Regulatory approvals Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 98: Technical Specifications

    Receive sensitivity, 2 Mb/s data rate -88 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 XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 99: Power Requirements

    Power requirements The following table provides the power requirements for the device. Band 25 is only supported by products containing SARA-R410M-02B-01 and newer. Band 25 is for LTE CAT M1 only. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 100: Power Consumption

    Active mode current Idle/connected, 20 mA 35 mA listening Power save mode 20 µA Not supported current Deep sleep current 10 µA 10 µA (USB direct mode must be disabled during sleep) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 101: Electrical Specifications

    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 (VCC - 0.15 V) or 3.3 V, VDD_IO Internal supply voltage VCC or 3.3 V, whichever is whichever is lower for I/O lower...

  • Page 102: Regulatory Approvals

    Lead-free and RoHS compliant AT&T end-device certified Complete Verizon end-device certified Complete PTCRB Complete Declaration ID: D042514 Bluetooth QDID: 121268 Mexico (IFETEL) IFT#: RCPDIXB20-2543 ANATEL: 18681-20-01209 Brazil (ANATEL) ANATEL: 07889-19-05903 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 103: Hardware

    Hardware Mechanical drawings Pin signals XBee header connector requirements RSSI PWM SIM card Associate LED functionality Development boards Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 104: Mechanical Drawings

    The following figures show the mechanical drawings for the XBee Smart Modem. All dimensions are in inches. For XBee header information, see XBee header connector requirements. Pin signals The pin locations are: Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 105 XBee devices for analog voltage reference. Associate / DIO5 Either Output Associated Indicator, Digital I/O 5 RTS / DIO6 Either Disabled Input Request-to-Send Flow Control, Digital I/O 6 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 106: Pin Connection Recommendations

    If running on the XBIB development board, DIO10 is connected to the RSSI LEDs, which may be interpreted as follows: Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 107: Sim Card

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 108 Hardware Associate LED functionality Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 109: Development Boards

    Hardware Development boards 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. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 110 XBee. When active, the VCC pin of the XBee is disconnected from the 3.3 V line on the development board. This allows current measurement to be conducted by attaching a current meter across the jumper P10. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 111 RESET button resets the XBee module when pressed. Breakout This 40 pin connects to various XBee pins as shown on the silkscreen Connector on the bottom of the board. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 112 I2C sensor. XBee Socket This is the socket for the XBee (TH form factor). XBee Test Point Allows easy access to pins 1 to 20 of the XBee. Pins Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 113: Xbib-C-Gps Reference

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 114: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 115 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 116: Antenna Recommendations

    Often, small antennas are desirable, but may come at the cost of reduced range and efficiency. If you implement the Bluetooth interface, ensure that the Bluetooth and cellular antennas are at least 3 inches apart (6 inches recommended) to prevent cellular sensitivity from being degraded. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 117 Design recommendations Cellular component firmware updates Power supply considerations Minimum connection diagram Heat considerations and testing Custom configuration: Create a new factory default Clean shutdown SIM cards Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 118: Design Recommendations

    3.2 V during operation. Minimum connection diagram In high EMI noise environments, we recommend adding a 10 nF ceramic capacitor very close to pin 5. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 119: Heat Considerations And Testing

    Bluetooth is enabled by default. When you use the RE command to reset the device to the factory defaults, the Bluetooth configuration is set to the custom configuration (enabled) rather than the original factory default (disabled). Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 120: 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 121: Sleep Feature

    Because vibrations in your application environment may cause unexpected SIM card failures due to fretting between the SIM card and the card holder, Digi strongly recommends that you apply a thin layer of dielectric grease to the SIM contacts prior to installing the SIM cards.

  • Page 122: Cellular Connection Process

    Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 123: Connecting

    1. The server closes the connection. 2. The TM timeout expires (see TM (IP Client Connection Timeout)). 3. The cellular network may also close the connection after a timeout set by the network operator. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 124: Disconnecting

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 125: Modes

    Modes Select an operating mode Transparent operating mode API operating mode Command mode MicroPython mode USB direct mode Bypass operating mode (DEPRECATED) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 126: 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 XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 127: Transparent Operating Mode

    When the device is in Command mode, it listens for user input and is able to receive AT commands on the UART. If CT time (default is 10 seconds) passes without any user input, the device drops out of Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 128: Troubleshooting

    Response to AT commands When using AT commands to set parameters the XBee Smart Modem responds with OK<cr> if successful and ERROR<cr> if not. For devices with a file system: Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 129: Apply Command Changes

    REPL or code launched at startup. 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 130: Usb Direct Mode

    USB direct mode USB direct mode Note In order to use USB direct mode in Digi XBee development kits, you must use the XBIB-C-TH development board. Note You should use this mode if you want to connect using PPP through the cellular modem while using a host operating system, such as embedded Linux.

  • Page 131: Configure The Data Pins

    2. Enable based on the state of VBUS (pin 6): Set P0 to 6. Apply a logic high signal to DIO10/PWM0 (pin 6) to enable USB or a logic low signal to disable USB. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 132: Configure And Use Ppp With A Digi Xbee 3 Cellular Lte-M/Nb-Iot Modem

    You must reset the device to enable or disable USB direct mode. While in USB direct mode, AI (Association Indication) returns 0x2B. Configure and use PPP with a Digi XBee 3 Cellular LTE-M/NB-IoT modem Your XBee 3 Cellular device can communicate directly with the modem and can drop into PPP mode. Prerequisites A working SIM card to get onto the LTE-M network.
  • Page 133 In the net-chat script below, you must replace <APN> with the correct APN for your network and SIM. ABORT 'ERROR' ABORT 'BUSY' ABORT 'NO CARRIER' '' AT OK AT+IFC=2,2 OK ATE0 OK AT+CGDCONT=1,"IP","<APN>" OK AT&S0 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 134 Connect script failed This indicates that the <APN> field was most likely not set correctly in the net-chat script. Error after running sudo pppd pppd: In file /etc/ppp/options: unrecognized option '/dev/ppp_direct_usb' Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 135: Bypass Operating Mode (Deprecated)

    To configure a device for Bypass operating mode: 1. Set the AP (API Enable) parameter value to 5. 2. Send WR (Write) to write the changes. 3. Send FR (Force Reset) to reboot the device. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 136: Leave Bypass Operating Mode

    0x2F. Restore cellular settings to default in Bypass operating mode Send AT&F1 to reset the cellular component to its factory profile. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 137: Sleep Modes

    About sleep modes Normal mode Pin sleep mode Cyclic sleep mode Cyclic sleep with pin wake up mode SPI mode and sleep pin functionality The sleep timer MicroPython sleep behavior Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 138: About Sleep Modes

    XBee Smart Modem, or keeps it awake. De-asserting SPI_SSEL by driving it high puts the device to sleep. If neither pin is configured as a peripheral, then the device stays awake, being unable to sleep when SM (Sleep Mode) is 1. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 139: The Sleep Timer

    (b'', (<address from connect()>, <port from connect()>) ) The underlying UDP socket resources have been released at this point. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 140 Power saving features and design recommendations Airplane mode Power Saving Mode (PSM) PSM behavior Low voltage shutdown Deep Sleep mode Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 141: Power Saving Features And Design Recommendations

    TCP or TLS connection, sending a UDP datagram, or sending an SMS. Typical applications do not need to Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 142 Features of the XBee 3 Cellular device that continually wake up the cellular component do not take advantage of power savings and should not be used in combination with PSM. Features that continually wake up the cellular component include: Persistent TCP connection to Digi Remote Manager (if bit 0 of MO is set).

  • Page 143: Psm Behavior

    Note The XBee VCC voltage gets read periodically, once every two minutes. Consequently, it may take up to two minutes to change to or from a shutdown state. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 144: Deep Sleep Mode

    In Deep Sleep mode the cellular component is shut off and the XBee processor is put to sleep. Note When the XBee Smart Modem enters deep sleep mode, any MicroPython code currently executing is suspended until the device comes out of sleep. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 145: 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 XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 146: 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 XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 147: 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 XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 148: I2C

    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. For I C see the Class I2C: two-wire serial protocol section in the MicroPython Programming Guide details. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 149 SPI operation SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Data format Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 150: Spi Operation

    SPI master cannot know when the slave needs to send and the SPI slave cannot transmit unless enabled by the master. For this reason, the SPI_ATTN signal is available in the Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 151: Low Power Operation

    Sleep modes generally work the same on SPI as they do on UART. However, due to the addition of SPI mode, there is an option of another sleep pin, as described below. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 152: Select The Spi Port

    SPI operation Select the SPI port 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. If SLEEP_REQUEST 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_REQUEST.

  • Page 153: Force Uart Operation

    The XBee Smart Modem sends 0xFF when there is no data to send to the host. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 154 File system For detailed information about using MicroPython on the XBee Smart Modem refer to the Digi MicroPython Programming Guide. Overview of the file system XCTU interface Encrypt files Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 155: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 156: Xctu Interface

    SHA256 hash of the file contents. In this way you can validate that the correct file has been placed on the XBee Smart Modem. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 157 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 158: Socket Behavior

    For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. 1 TCP socket is used for Remote Manager, so if you have Remote Manager enabled, subtract 1 socket from the values above. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 159: Socket Limits In Api Mode

    If the connection is disconnected at any time, send a Transmit TX Request frame to trigger a new connection attempt. To send data over this connection use the Transmit (TX) Request: IPv4 - 0x20. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 160: Api Mode Behavior For Outgoing Udp Data

    The XBee Smart Modem does not currently support the TLS protocol for incoming connections. Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 161: Api Mode Behavior For Incoming Udp Data

    No data has been sent or received for longer than the socket timeout set by TM (IP Client Connection Timeout). You make and apply a change to the IP, DL, or DE. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 162: Transparent Mode Behavior For Outgoing Udp Data

    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 XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 163: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 164: 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 165: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 166: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 167: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 168: 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: 7E 00 03 40 01 00 BE Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 169: Receive A Socket Create Response

    Value 0xC6 (Socket Bind/Listen Response) Frame type Frame ID 0x01 Socket ID 0x00 Status 0x00 (Success) Socket Bind/Listen Response received from XBee: 7E 00 04 C6 01 00 00 38 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 170: Send To Digi Echo Server

    Extended Socket frames Extended Socket example: UDP 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) Frame type Frame ID 0x01 Socket ID...

  • Page 171: 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 172: Close The Socket

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 173: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 174: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 175: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 176 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 177: Transport Layer Security (Tls)

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 178: Specifying Tls Keys And Certificates

    This module will only work with the originating end of chain Root CA, so you will need to use that one. For example, with Amazon web services ATS endpoints Digi recommends that you use the Starfield Services Root Certificate from https://ssl-ccp.secureserver.net/repository/sf-class2-root.crt.

  • Page 179: Transparent Mode And Tls

    For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Certificate formats For SARA-R410 cellular components used in the XBee 3 Cellular LTE-M Global Smart Modem, if the server certificate has a Common Name (CN) that is greater than 31 characters the SSL connection fails.

  • Page 180: Cipher Suites

    The XBee devices that have the *11 or later version of the firmware installed are by default able to secure the TLS connection to Digi Remote Manager. The default configuration provides confidentiality of the communication but is not able to authenticate the server without a certificate being provided.

  • Page 181: Step 1: Get The Certificate

    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 182 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 183 Sleep commands Command mode options MicroPython commands Firmware version/information commands Diagnostic interface commands Execution commands File system commands BLE commands Remote Manager commands System commands Socket commands Power measurement commands Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 184: 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 185: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 186: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 187: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 188: An (Access Point Name)

    Note This value should only be used with Verizon home network SIM cards. Setting the value to 3 with other SIM cards may adversely affect network registration and activity. Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 189: Bm (Bandmask) (Lte-M)

    WARNING! If this value is configured incorrectly, the XBee module may be unable to locate a tower and join the network. Parameter range 0 - 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF (bit field) Example: 0x080080 (bits 7 and 19) enable NB-IoT Bands 8 and 20. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 190: Am (Airplane Mode)

    1 = Airplane mode Default N# (Preferred Network Technology) Allows the XBee 3 Cellular LTE-M/NB-IoT module to select the preferred network technology. A reboot or power cycle is required for any parameter changes to become active. Note For the N# command configuration to take effect, the command must be set to 1 (No Profile).

  • Page 191: Sw (Reference Signal Received Power)

    4 to 8 ASCII digits or space character. A value of a single space character (ASCII 0x20) acts as an empty value. Default 0x20: A single ASCII space character that indicates there is no PIN. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 192: Pk (Sim Puk)

    If the value cannot be retrieved for some reason, such as the device is not on the network, the response is empty. When in command mode and the value cannot be retrieved, OK is returned. Parameter range Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 193: Network Commands

    For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Range Value Description 0x00 SSL v3 0x01 TLS v1.0 0x02 TLS v1.1 0x03 TLS v1.2 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 194: Tls Profile 0)

    2. Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Format server_cert;client_cert;client_key Parameter range From 1 through 127 ASCII characters. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 195: Tm (Ip Client Connection Timeout)

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 196: Dx (Requested Edrx Cycle Length)

    The specific legal values depend on network access technology and carrier policy. The maximum value, where data is retained by the network without loss, also depends on carrier policy and this value should be selected in light of guidance provided by your carrier. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 197: D? (Network-Provided Edrx Cycle Length)

    The command sends a single request with a timeout of five seconds. If five seconds elapses with no response the command will timeout and report an error. Parameter range Valid FQDN (Fully Qualified Domain Name) or IP address Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 198: Addressing Commands

    International Dialing Prefix for your calling region, for example, 011 for the United States. Note For information on SMS transmissions in API mode, see Transmit (TX) SMS - 0x1F. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 199: N1 (Dns Address)

    To set the destination address to a domain name, the value must be a legal Internet host name, for example remotemanager.digi.com Parameter range 0 - 128 ASCII characters Default 0.0.0.0 The destination IPv4 address or fully qualified domain name used by Transparent mode. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 200: Od (Operating Destination Address)

    IP (IP Protocol) sets the protocol used. For more information on using incoming connections, see Socket behavior. Parameter range 0 - 0xFFFF Value Description Disabled Non-0 Enabled on that port Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 202: Serial Interfacing Commands

    19200 b/s 38400 b/s 57600 b/s 115200 b/s 230400 b/s 460800 b/s 921600 b/s Default 0x3 (9600 b/s) NB (Parity) Set or read the serial parity settings for UART communications. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 203: Sb (Stop Bits)

    Transparent mode is not transmitted until that character is received. To use a carriage return, set to 0xD. Set to zero to disable text delimiter checking. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 204: Ft (Flow Control Threshold)

    Bypass mode Default IB (Cellular Component Baud Rate) Note Digi does not recommend using bypass mode. You should use USB Direct mode instead. Sets the serial interface baud rate for communication between the XBee CPU and the cellular component when in bypass mode. You can set bypass mode by setting the AP command...
  • Page 205 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 460800 b/s 921600 b/s Default uBlox based modules: 0x9 (460800 baud) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 206: I/O Settings Commands

    XBee leaves sleep. Default D1 (DIO1/AD1) Sets or displays the DIO1/AD1 configuration (pin 19). Parameter range 0 - 6 Parameter Description Disabled SPI_ATTN Digital input Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 207: D2 (Dio2/Ad2)

    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 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 208: D4 (Dio4)

    Sets or displays the DIO6/RTS configuration (pin 16). Parameter range 0, 1, 3 - 5 Parameter Description Disabled RTS flow control Digital input Digital output, default low Digital output, default high Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 209: D7 (Dio7/Cts)

    0, 1, 3 - 5 Parameter Description Disabled SLEEP_REQUEST input Digital input Digital output, default low Digital output, default high Default D9 (DIO9/ON_SLEEP) Sets or displays the DIO9/ON_SLEEP configuration (pin 13). Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 210: P0 (Dio10/Pwm0 Configuration)

    PWM0 output Digital input Digital output, low Digital output, high USB VBUS Default P1 (DIO11/PWM1 Configuration) Sets or displays the DIO11 configuration (pin 7). Parameter range 0, 1, 3 - 7 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 211: P2 (Dio12 Configuration)

    0, 1, 3 - 5 Parameter Description Disabled SPI_MISO Digital input Digital output, default low Digital output, default high Default P3 (DIO13/DOUT) Sets or displays the DIO13/DOUT configuration (pin 17). Parameter range 0, 1 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 212: P4 (Dio14/Din)

    Use the PD command to specify whether the resistor is pull-up or pull-down. If you set a PR bit to 1, it enables the pull-up/down resistor. If you set a PR bit to 0, it specifies no internal pull-up/down resistor. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 213: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 214: M1 Command

    I/O settings commands M1 command Sets the duty cycle of PWM1 for P1 = 2, where a value of 0x200 is a 50% duty cycle. Parameter range 0 - 0x3FF Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 215: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 216 AT commands I/O sampling commands Field Size Analog chanel mask 1 byte Samples 2 bytes each Parameter range Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 217: Sleep Commands

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 218: Pa (Requested Active Timer)

    T3412. Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Parameter range 0 - 0x35683200 (* 1 s) Default 0x8ca00 (576000 s) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 219: 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 - 0x6D3 (x 1 ms) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 220 AT commands Command mode options Default 0x3E8 (one second) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 221: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 222 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 223: Firmware Version/Information Commands

    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. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 224: Ai (Association Indication)

    Regulatory testing has been enabled. See Regulatory testing commands 0x31 (Enable/disable test mode). 0xFF Initializing. Parameter range 0 - 0xFF [read-only] Default FI (FTP OTA Update Indication) Reports the result of the previous FTP OTA operation. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 225: Fo (Ftp Ota Command)

    ATFI to get the status of the last FTP OTA operation. This can return ERROR immediately if there are invalid parameters set or another FTP OTA already in progress. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 226 ATFOC ATFOC clears all parameters back to their defaults as listed in the table above. Example usage Setting a parameter ATFOSmyftp.server.com Reading a parameter ATFOS myftp.server.com Initiating FTO OTA ATFOI Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 227: Diagnostic Interface Commands

    The following AT commands are diagnostic interface commands. DI (Remote Manager Indicator) Displays the current Remote Manager status for the XBee. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. Range Value Description 0x00 Connected, but without TLS or authentication.
  • Page 228 Unknown server - DNS lookup failed. 0x26 Connection refused. 0x27 Connection lost. 0x28 Unknown. 0xFF No known status. The following table provides the parameter's meaning when IP = 2 for SMS connections. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 229: As (Active Scan For Network Environment Data)

    0 or no value in the service area of the module. When you run the command, the cell module waits until all other communication is idle and then performs the scan. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 230 AT commands Diagnostic interface commands Parameter range Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 231: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 232: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 233: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 234: Atfs Format Confirm

    The XBee Smart Modem responds with Formatting..., adds a period every second until the format is complete and ends the response with a carriage return. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 235: Ble Commands

    Sets or displays the output power level that will be used for Bluetooth advertisements. Parameter range 0x0 - 0x3 Description -20 dBm -10 dBm 0 dBm 8 dBm Default 3 (8 dBm) BT (Bluetooth enable) Enables or disables the Bluetooth functionality. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 236: S (Srp Salt)

    The salt is configured in the $S command. In the $V, $W, $X, and $Y verifiers, you specify the 128-byte verifier value, where each command represents 32 bytes of the total 128-byte verifier valule. Parameter range 1 - 32 bytes (1-64 hexadecimal characters in command mode) Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 237: Remote Manager Commands

    Specify the Remote Manager Device Send Transmit Keepalive Interval value in seconds. The Remote Manager considers a connection to have failed after 3 missed keepalives. This command works with the K1 command to limit data usage. See Configure Remote Manager keepalive interval. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 238: Mo (Remote Manager Options)

    Defines the TLS Remote Manager certificate. Parameter range Default /flash/cert/digi-remote-mgr.pem RI (Remote Manager Service ID) Sets the Remote Manager service ID for the XBee. Configure SMS messaging in Remote Manager for more information. Range Default idgp Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 239: Dp (Remote Manager Phone Number)

    This is the same value as reported by the command, in dB. Module Temperature in Celsius. This is reported to the "metrics/temperature" Data Stream in Remote Manager for the devices. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 240: Er (Remote Manager Tcp Port Override)

    Value is 0: The default Remote Manager TCP port is used. Value is non-zero: Specify the TCP port that should be used. The default Remote Manager TCP port is overridden. Parameter range 0x0 - 0xFFFF Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 241: Remote Manager Udp Port Override)

    This command works in conjunction with the MO command. If MO bit 0 is set (to maintain a persistent TCP connection to Remote Manager), the configuration for the MT command is ignored. Parameter range 0x1 - 0x5A0 Default Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 242: System Commands

    One ASCII space character (0x20) KC (Contact Information) Sets or displays user-defined contact information for the XBee displayed in Remote Manager. Range Up to 20 ASCII characters Default One ASCII space character (0x20). Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 243: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 244: Power Measurement Commands

    Sets the voltage threshold in millivolts at which the XBee enters a shutdown state. You must enable this feature by setting the DO command bit 4. See Low voltage shutdown. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 245: M (Low Voltage Shutdown Reset Offset)

    XBee recovers from a shutdown state by resetting. You must enable this feature by setting the command bit 4. See Low voltage shutdown. Parameter range 0x64 - 0x2BC mV Default 0xC8 mV Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 246 Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 247: 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 XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 248: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 249 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 250 FF. 01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F + B8 = 2FF Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 251: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 252: At Command - 0X08

    Command name: two ASCII characters that identify the AT command command. Parameter Byte If present, indicates the requested parameter value to set the value given register. If no characters are present, it queries the register. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    Command name: two ASCII characters that identify the AT command command. Parameter Byte If present, indicates the requested parameter value to set the value given register. If no characters are present, it queries the register. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 254: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    If there is no matching socket, the TX Status frame returns an error. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 256 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. UDP is limited to 512 bytes. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    If there is no matching socket, the TX Status frame returns an error. TLS profile Byte Zero-indexed number that indicates the profile as specified by the corresponding $<num> command. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 258 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 259: At Command Response - 0X88

    1 = ERROR 2 = Invalid command 3 = Invalid parameter Parameter Byte Register data in binary format. If the register was set, then this value field is not returned. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    Message too long 0x76 Socket closed unexpectedly 0x78 Invalid UDP port 0x79 Invalid TCP port 0x7A Invalid host address 0x7B Invalid data mode Invalid interface. See User Data Relay - 0x2D. 0x7C Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 261 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 262: Modem Status - 0X8A

    The BLE Connect and BLE Disconnect events are reported over the UART/SPI interface in API mode when a valid Bluetooth connection has been made and API mode has been unlocked, and also when an unlocked connection disconnects. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    LSB 11 0 = UDP Protocol MSB 12 1 = TCP 4 = SSL over TCP Status Reserved Payload Data received from the source. The maximum size is 1500 bytes. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 265: User Data Relay - 0X2D

    BLE connection. Use a cellphone to send the frame with UART interface as a target. Data contained within the frame is sent out the UART contained within an Output Frame. The external processor then receives and acts on the frame. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 266 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 267: User Data Relay Output - 0Xad

    Field value Data type Description Frame type 0xAD Byte Byte 0 = Serial port (SPI, or UART Source interface when in API mode) 1 = BLE 2 = MicroPython Data Variable Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 268: Ble Unlock Api - 0X2C

    Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Frame data fields Offset Description Frame type 0x2C = Request 0xAC = Response Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 269 Phase 2 (Server presents B and salt) Frame data field Offset in frame Length salt 4 bytes 128 bytes Phase 3 (Client presents M1) Frame data field Offset in frame Length Hash algorithm digest length (32 bytes for SHA256) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 270: Example Sequence To Perform At Command Xbee Api Frames Over Ble

    When successful, the response arrives in one or more indications. If your stack does not do it for you, remember to acknowledge each indication as it is received. Note that you are Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 271 Decrypt the stream of content provided through the indications, using the stream cipher as described in the unlock procedure. See BLE Unlock API - 0x2C. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 272: Ble Unlock Response - 0Xac

    The XBee Smart Modem uses the BLE Unlock API - 0x2C frame to authenticate a connection on the Bluetooth interface and unlock the processing of AT command frames. This frame is used in conjunction with the Response (0xAC) frame. For details, see BLE Unlock API - 0x2C. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 273: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 274: Socket Create Response - 0Xc0

    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. 0x85 Unknown error 0x86 Invalid TLS configuration Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 275: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 276: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 277: Socket Connect - 0X42

    IPv4 address in network address type byte 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 278: Socket Connect Response - 0Xc2

    Connection already in progress 0x04 Already connected 0x05 Socket Connect is not allowed on this socket. The socket is closed, closing, or in a bound/listening state. 0x20 Invalid socket ID Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 279: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 280: Socket Close Response - 0Xc3

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 281: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 282: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 283: Socket Bind/Listen - 0X46

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 284: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 285: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 286: Socket Receive - 0Xcd

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

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

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 288: Socket Status - 0Xcf

    For more information about the file system, see File system. Note The XBee modules responds to these requests with Local File System Response - 0xBB. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 289 File Write 0x04 File Hash 0x08 Directory Create 0x10 Directory Open 0x11 Directory Close 0x12 Directory Read 0x13 Get Path ID 0x1C Delete 0x2F Volume Info 0x40 Volume Format 0x4F Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 290: File Open - 0X01

    (CREATE + EXCLUSIVE) or replacing an existing file (TRUNCATE). Request Offset Size Frame Field Description File System Command 8-bit File Open - 0x01 Path ID Get Path ID - 0x1C for a description. 16-bit Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 291: File Close - 0X02

    Frame Field Description File System Command 8-bit File Close - 0x02 File Handle Value returned from File Open - 0x01 response. 16-bit File Read - 0x03 Description Read the file. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 292: File Write - 0X04

    File position for write, or 0xFFFFFFFF to use the current position. Data Data to write to file. If empty, frame just refreshes the File 12-n variable Handle timeout to keep the file open. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 293: File Hash - 0X08

    7-38 32-bytes Hash used to verify file contents. Directory Create - 0x10 Description Create a directory. Request Offset Size Frame Field Description File System Command 8-bit Directory Create - 0x10 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 294: Directory Open - 0X11

    ENTRY_IS_LAST flag automatically closes the Directory Handle. Offset Size Frame Field Description File System 8-bit Directory Read - 0x13 or Directory Open - 0x11, Command depending on request. Status Success - 0x00 16-bit Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 295: Directory Close - 0X12

    The host can send this frame to indicate that it is done reading the directory and no longer needs the Directory Handle. Note that the Directory Handle is automatically closed and no longer valid after receiving a Response with the ENTRY_IS_LAST flag set. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 296: Directory Read - 0X13

    The full, absolute path of the Path ID is included in the Response only if can fit. Any code used to process the response needs to take that into account and handle an empty Full Pathname field. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 297: Delete - 0X2F

    16-bit Path Name Pathname of file or empty directory to delete. variable Volume Info - 0x40 Description Get volume information: used space, available space, and unusable bytes on volume. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 298: Volume Format - 0X4F

    Frame ID. The contents of the variable-length Response Data field appear in the documentation for each File System Command. Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 299 File/Directory already exists 0x52 File/Directory does not exist 0x53 Invalid name 0x54 File operation on directory 0x55 Cannot delete non-empty directory 0x56 Attempt to read past EOF (end of file) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 300 0x58 Volume offline/format required 0x59 Volume full 0x5A Operation timed out 0x5B Busy (wait for prior command to complete then try again) 0x5C Resource failure (memory allocation failed, try again) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 301: Regulatory Firmware

    Install the regulatory firmware You can install the regulatory firmware from either XCTU or Remote Manager. Install regulatory firmware using XCTU You can install the regulatory firmware on your XBee using XCTU. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 302: Install Regulatory Firmware Using Remote Manager

    Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. WARNING! The firmware version 1140F reorganizes the product's flash memory and upgrades the product to version 11410. You cannot downgrade to a version earlier than 11410 after installing 1140F/11410.

  • Page 303: Configure Regulatory Firmware For Testing The Bluetooth Radio

    2. Disable USB Direct mode, if it is currently enabled. Set = 0. 3. Disable airplane mode, if it is currently enabled. Set = 0. 4. Configure the XBee in transparent mode. Set = 0. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 304: Bluetooth Dtm Protocol

    The commands work in conjunction with regulatory firmware which you must install onto your XBee before you use these commands. Use the commands Before you can use these commands for regulatory compliance testing, you must do the following: Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 305: (Enable/Disable Test Mode)

    When test mode is enabled, the module will report an AI value of 0x31. Parameter range Description Disables test mode. Enables test mode. Default Disabled Examples Enable test mode: AT%#1 Disable test mode: AT%#0 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 306: Start Test Mode)

    Use this command to set the EARFCN (Absolute Radio Frequency Channel Number). Parameter range 0 - 65535 This is specified in decimal to conform to standard representations found in specifications without need for translation. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 307: Get The Earfcn)

    The XBee 3 LTE-M module only accepts whole integer dBm and will truncate the fractional portion. Default Examples Set transmit power to 0 dBm: AT%9000 Set transmit power to -1 dBm: AT%9FF0 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 308: A (Get Transmit Power)

    Inactive (Test mode not yet started.) Transition (Attempting to activate test mode.) Off (Test mode started, but no active test.) Receive mode Transmit mode An error occurred Example Query test state: AT%? Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 309: Troubleshooting

    Unresponsive cellular component in Bypass mode Syntax error at line 1 Error Failed to send SMS Network connection issues Brownout issue Hardware flow control in Bypass mode Baud rate in Bypass mode Socket leaks Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 310: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 311: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 312: 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 313: Unresponsive Cellular Component In Bypass Mode

    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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 314: Network Connection Issues

    Silicon Labs has corrected these issues in revision C of their SoC. We are printing the SoC revision on the XBee label to make it easy to distinguish. The revision letter is located on the bottom right corner Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 315: Hardware Flow Control In Bypass Mode

    Hardware flow control in Bypass mode Support for hardware flow control in Bypass mode is available with version L0.0.00.00.05.08,A.02.04 of the SARA-R410M cellular component.  Digi recommends that you update to at least firmware version L0.0.00.00.05.08,A.02.04 of the cellular component (using a serial port from Remote Manager) and firmware version 11414 of the XBee Smart Modem.

  • Page 316: Solution

    When attempting to make a connection to a server you receive errno.ENFILE MicroPython (7023) Solution To recover the leaked sockets and make them available again in all modes, you should perform a reset of the cellular component (hard or soft). Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 317 Regulatory information United States (FCC) Innovation, Science and Economic Development Canada (ISED) Mexico (IFETEL) Brazil (ANATEL) Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 318: United States (Fcc)

    You must include a clearly visible label on the outside of the final product enclosure that displays the following content: Required FCC Label for OEM products containing the XBee 3 Cellular LTE-M RF Module Contains FCC ID: MCQ-XB3M1 Contains FCC ID: XPY2AGQN4NNN The enclosed device complies with Part 15 of the FCC Rules.

  • Page 319: Fcc-Approved Antennas

    If the antenna is mounted at least 25 cm 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 320: Rf Exposure

    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 321: Innovation, Science And Economic Development Canada (Ised)

    25 cm from all persons and must not be co-located or operating in conjunction with any other antenna or transmitter. ATTENTION! Cet équipement est approuvé pour la mobile et la station base dispositifs d'émission seulement. Antenne(s) utilisé pour cet émetteur doit être installé pour fournir Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 322: Mexico (Ifetel)

    WARNING! The Original Equipment Manufacturer (OEM) must ensure that Mexico IFT labeling requirements are met. The IFETEL number for the Digi XBee® 3 Cellular LTE-M/NB-IoT product must be listed either on the end product, on the packaging, in the manual, or in the software with the following phrase: “Este equipo contiene el módulo XB3M1 con Número IFETEL: RCPDIXB20-2543”...

  • Page 323: Brazil (Anatel)

    Para maiores informações, consulte o site da ANATEL www.anatel.gov.br. Este equipamento não tem direito à proteção contra interferência prejudicial e não pode causar interferência em sistemas devidamente autorizados. ANATEL: 18681-20-01209 ANATEL: 07889-19-05903 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 324: Deprecated Kit (Pn Xk3-C-A2-Ut-U Or Xk3-C-N1-Ut-E)

    Deprecated kit (PN XK3-C-A2-UT-U or XK3-C-N1-UT-E) This section includes hardware and connection information for the deprecated kit, Digi XBee 3 Cellular LTE-M/NB-IoT (part numbers XK3-C-A2-UT-U or XK3-C-N1-UT-E). The deprecated kit includes the XBIB- U-DEV development board. Note Information about how to configure and manage the XBee on the XBIB-U-DEV development board can be found in this guide.

  • Page 325: Identify The Kit Contents

    NB-IoT kits (Digi product number XK3-C-N1-UT-E) do not include a SIM card. Contact your NB-IoT mobile carrier provider to obtain a SIM card and service. Determine cellular service and acquire a SIM card. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 326: Connect The Hardware

    4. Connect the antennas. a. Connect the cellular antenna. b. Connect the BLE antenna if you are using BLE functionality. If you are not, you do not have to connect the BLE antenna. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 327: Xbib-U-Dev Reference

    If you have trouble downloading the USB driver, see Other possible issues. XBIB-U-DEV reference This picture shows the XBee USB XBIB-U-DEV development board and the table that follows explains the call-outs in the picture. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 328 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® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 329 Deprecated kit (PN XK3-C-A2-UT-U or XK3-C-N1-UT-E) XBIB-U-DEV reference Number Item Description 20-pin header Maps to standard through-hole XBee pins. Male, Samtec header, part number: TSW-110-26-L-D. 2.54 mm / .100" pitch and row spacing. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

  • Page 330: Example: Turn On An Led

    # This means setting the pin to 0 allows current to flow through the LED and then through the pin, to ground. 3. To turn it off, type the following and press Enter: Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
  • Page 331 Deprecated kit (PN XK3-C-A2-UT-U or XK3-C-N1-UT-E) Example: turn on an LED led.value(1) You have successfully controlled an LED on the board using basic I/O. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...

This manual is also suitable for:

Xbee 3 cellular nb-iot

Table of Contents