1. Manuals
  2. Brands
  3. Digi Manuals
  4. Modem
  5. XBee 3 Global LTE-M/NB-IoT
  6. User manual

Digi XBee 3 Global LTE-M/NB-IoT User Manual

Smart modem (including low power variant)
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Digi XBee®3 Global LTE-M/NB-IoT
Smart Modem (including Low Power variant)
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XBee 3 Global LTE-M/NB-IoT and is the answer not in the manual?

Questions and answers

Related Manuals for Digi XBee 3 Global LTE-M/NB-IoT

Summary of Contents for Digi XBee 3 Global LTE-M/NB-IoT

  • Page 1 Digi XBee®3 Global LTE-M/NB-IoT Smart Modem (including Low Power variant) User Guide...

  • Page 2: Trademarks And Copyright

    Removing LTE-M conditions from document. Trademarks and copyright Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners.

  • Page 3: Country Of Manufacture

       Trace (if possible)    Description of issue    Steps to reproduce Contact Digi technical support: Digi offers multiple technical support plans and service packages. Contact us at +1 952.912.3444 or visit us at www.digi.com/support. Feedback To provide feedback on this document, email your comments to techcomm@digi.com...

  • Page 4: Table Of Contents

    Contents Country of manufacture Digi XBee®3 Global LTE-M/NB-IoT User Guide Applicable firmware and hardware Safety instructions XBee modules SIM cards NB-IoT network Get started with the XBee Identify the kit contents Determine cellular service and acquire a SIM card US customers...
  • Page 5 Get started with Bluetooth® Low Energy Enable BLE on an XBee device Connect with BLE and configure your XBee device Enable BLE and configure the BLE password using XCTU Get the Digi XBee Mobile phone application BLE reference BLE advertising behavior and services Device Information Service XBee API BLE Service...
  • Page 6 Pin connection recommendations XBee header connector requirements SIM card Antenna recommendations Antenna placement GNSS antennas GNSS (Global Navigation Satellite System) Design recommendations Cellular component firmware updates Power supply considerations Minimum connection diagram Heat considerations and testing Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 7 Restore cellular settings to default in Bypass operating mode 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 Sleep timer MicroPython sleep behavior Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 8 Socket limits in API mode UDP datagram size limits Enable incoming TCP connections API mode behavior for outgoing TCP and TLS connections API mode behavior for outgoing UDP data API mode behavior for incoming TCP connections Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 9 API mode and TLS Key formats Certificate limitations Secure the connection between an XBee and Remote Manager with server authentication Step 1: Get the certificate Step 2: Configure device Step 3: Verify that authentication is being performed Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 10 W? (Network-provided eDRX Paging Time Window length) PG (Ping) Addressing commands SH (Serial Number High) SL (Serial Number Low) MY (Module IP Address) P# (Destination Phone Number) N1 (DNS Address) N2 (DNS Address) DL (Destination Address) OD (Operating Destination Address) Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 11 Command mode options 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 Global LTE-M/NB-IoT User Guide...
  • Page 12 HF (Health Metrics Reporting Frequency) HM (Health Metrics) 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) Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 13 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 Global LTE-M/NB-IoT User Guide...
  • Page 14 %9 (Set transmit power) %A (Get transmit power) %D (Start receive mode) %H (Set channel mapping) %I (Get channel mapping) %? (Query test state) Troubleshooting Cannot find the serial port for the device Condition Solution Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 15 Innovation, Science and Economic Development Canada (ISED) Labeling requirements RF Exposure Antenna regulatory information: IC (Canada) European Union (EU) Antenna regulatory information: EU (European Union) United Kingdom (UKCA) Cellular antenna max gain: UKCA (United Kingdom) Brazil (ANATEL) Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 16: Digi Xbee®3 Global Lte-M/Nb-Iot User Guide

    The XBee provides OEMs with a simple way to integrate low-power cellular connectivity into their devices. Features include: FCC certified and carrier end-device certified Excellent coverage and building penetration Manage and configure with XCTU and Digi Remote Manager® Available with Digi provided SIM cards and data plans Digital I/O support Analog input support Transparent...

  • 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: Sim Cards

    For NB-IoT, SMS support is dependent on the network. Contact your network provider for details. Digi Remote Manager® requires TCP and will not work with NB-IoT unless the network supports TCP. The SIM card in the device determines whether the device supports NB-IoT, LTE-M, or both.

  • Page 19: Get Started With The Xbee

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

  • Page 20: Identify The Kit Contents

    One Bluetooth Low Energy (BLE) antenna One USB-C cable Note This cable is used to power the development board. One Micro USB cable Note This cable is used only with USB Direct mode. This cable will not power the development board. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 21 ESD wrap. One SIM card Note 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 Global LTE-M/NB-IoT User Guide...

  • Page 22: 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 23: Connect The Hardware

    Connect the GNSS antenna. For information about this antenna, see Antenna recommendations. c. 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 Global LTE-M/NB-IoT User Guide...

  • Page 24: 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 a serial peripheral interface (SPI).

  • Page 25: Update The Device Firmware Using Xctu

    Some carriers require an APN. If the carrier does not require an APN, you should not change the APN from the default 1. Launch XCTU 2. Click the Configuration working modes button 3. Select an XBee module from the Radio Modules list. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 26: Check For Cellular Registration And Connection

    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. Note If you are having trouble attachment to the network, see Verify that radio channels match your carrier.
  • Page 27 Showing anything else means the device is registered. 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 Global LTE-M/NB-IoT User Guide...

  • Page 28: Xbee Connection Examples

    Connect to the Echo server Connect to the ELIZA server Connect to the Daytime server Send an SMS message to a phone Perform a (GET) HTTP request Connect to a TCP/IP address Debugging Software libraries Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 29: Connect To The Echo Server

    7. To enter the destination address of the echo server, in the DL field, type 52.43.121.77 and click the Write button. 8. To enter the destination IP port number, in the DE field, type 2329 and click the Write button. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 30: Connect To The Eliza Server

    IP is not whitelisted by your carrier you will not be able to run this example. 2328 (0x2328) The target port number of the ELIZA server. (Destination Port) To communicate with the ELIZA Therapist Bot: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 31: Connect To The Daytime Server

    Therapist Bot. The following screenshot provides an example of this chat with the user's text in blue. Connect to the Daytime server The Daytime server reports the current Coordinated Universal Time (UTC) value responding to any user input. Note For help with debugging, see Debugging. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 32 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 Global LTE-M/NB-IoT User Guide...

  • Page 33: Send An Sms Message To A Phone

    1. Ensure that the device is set up correctly with the SIM card installed and the antennas connected as described in Connect the hardware. 2. Open XCTU and Add a device to XCTU. 3. Click the Configuration working mode button. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 34: Perform A (Get) Http Request

    2. Open XCTU and Add a device to XCTU. 3. Click the Configuration working mode button. 4. Select a device from the Radio Modules list. XCTU displays the current firmware settings for that device. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 35: Connect To A Tcp/Ip Address

    TCP/IP server. Note For help with debugging, see Debugging. The following table explains the AT commands that you use in this example. Command Value Description IP (IP Set the expected transmission mode to TCP communication. Protocol) Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 36: Debugging

    2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Software libraries One way to communicate with the XBee device is by using a software library. The libraries available for use with the XBee include: Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 37 The XBee Python Library is a Python API that dramatically reduces the time to market of XBee projects developed in Python and facilitates the development of these types of applications, making it an easy process. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 38: Get Started With Micropython

    MicroPython on the XBee 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 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 39: About Micropython

    Write button 5. Note what COM port(s) the XBee is using, because you will need this information when you use terminal communication. The Radio Modules information panel lists the COM port in use. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 40: Use The Micropython Terminal In Xctu

    1. At the MicroPython >>> prompt, type the Python command: print("Hello, World!") 2. Press Enter to execute the command. The terminal echos back Hello, World!. Other terminal programs if you do not use the MicroPython Terminal in XCTU. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 41: Example: Turn On An Led

    This sample code is handy for debugging the secondary Universal Asynchronous Receiver/Transmitter (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): Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 42: Exit Micropython Mode

    1. Open Tera Term. The Tera Term: New connection window appears. 2. Click the Serial radio button to select a serial connection. 3. From the Port: drop-down menu, select the COM port that the XBee is connected to. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 43: Use Picocom In Linux

    10. Press Ctrl+B to get the MicroPython version banner and prompt. Now you can type MicroPython commands at the >>> prompt. Use picocom in Linux With the XBee in MicroPython mode (AP = 4), you can access the MicroPython prompt using a terminal. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 44 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 Global LTE-M/NB-IoT User Guide...

  • Page 45: Get Started With Bluetooth® Low Energy

    Create a new factory default. 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. 2. Open the Digi XBee Mobile application. The Find XBee devices screen appears and the app automatically begins scanning for devices.

  • Page 46: Enable Ble And Configure The Ble Password Using Xctu

    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 Bitwarden or Keepass for generating and storing passwords for many devices.

  • Page 47: 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 48: Api Request Characteristic

    This characteristic cannot be read directly. 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 Global LTE-M/NB-IoT 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

    , 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

    Get started with Digi Remote Manager Configure Remote Manager features using automations Verify the connection between a device and Remote Manager By default, the XBee is configured to enable communication with Remote Manager. The communication between XBee and Remote Manager is achieved using periodic UDP operations.

  • Page 52: Overview: Create An Automation

    Click Confirm to start the automation. Automation examples The examples in the following sections assume you are using the Digi Remote Manager Automations 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: Read Settings And State Using Remote Manager

    Get started with Digi Remote Manager Automation examples Example: Read settings and state using Remote Manager In order to configure devices you will need to know the structure of the XML for your XBee's settings. The easiest way to obtain this is to perform a query_setting RCI request against your device.

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

    Update the 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: Example: Schedule An Automation To Update The Device Firmware Using Remote Manager

    You must upgrade your device to the latest firmware for all features to be available. See Update the firmware. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. To upgrade using an automation, perform the following steps: Log into Remote Manager.

  • Page 56: Example: Update Micropython From Remote Manager Using An Automation

    FTP client capability to the MicroPython application. You will need to add the library uftp.py and then update the main.py application. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. Log into Remote Manager.
  • Page 57 Get started with Digi Remote Manager Automation examples c. Click + again to add another step, and select RCI. i. In the RCI Payload field, enter: <set_setting> <remote_manager> <MO>7</MO> </remote_manager> </set_setting> ii. Enable Allow Offline. iii. From the On Error list box, select Continue.

  • Page 58: Manage Data In 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 59: Manage Secure Files In Remote Manager

    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 60: Tcp Connection

    Get started with Digi Remote Manager Remote Manager reference 4. Click Details. 5. From the Actions list box, choose Configure SM/UDP. 6. Click Enable. TCP connection The TCP connection between an XBee and Remote Manager is dependent on the device's firmware version.

  • Page 61: Determine The Location Of The Firmware Version

    Determine the location of the firmware version You must first determine the location of the firmware version to which you want to update. Digi provides updates by hosting them on an FTP server: ftp1.digi.com. If the FTP location is not accessible to your XBee Cellular, such as if you are using a VPN, the files may be retrieved and hosted separately on a server that it can reach.

  • Page 62: Configure Xbee Settings Within Remote Manager

    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 63 Request connect feature 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...

  • Page 64: Device Requests In Remote Manager

    Get started with Digi Remote Manager Device Requests in Remote Manager 6. Click Action > Configure SMS. 7. In the Phone Number field, enter the device's SIM card phone number. You can use the (Phone Number) command to discover the device's phone number.
  • Page 65 Get started with Digi Remote Manager Device Requests in Remote Manager The format operation closes all files open by other users of the system, including those that may be in use by a MicroPython application. The contents of the filesystem are reset to their initial default state. ...

  • 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 Global LTE-M/NB-IoT User Guide...

  • Page 67: Get Started With Coap

    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 Code Message ID Token (if any, TKL bytes) ... Options (if any) ... 1 1 1 1 1 1 1 1 Payload (if any) ... This is an example GET request: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 68: Configure The Device

    9. Wait for the AI (Association Indication) value to change to 0 (Connected to the Internet). You can click Read to get an update on the AI value. Example: manually perform a CoAP request Follow the steps in Configure the device prior to this example. This example performs the CoAP GET request: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    HTTP protocol and how to do this using the XBee. In this example, the XBee 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 to talk to the remote CoAP server.

  • Page 70: Get Started With Mqtt

    MQ Telemetry Transport (MQTT) is a messaging protocol that is ideal for the Internet of Things (IoT) due to a light footprint and its use of the publish-subscribe model. In this model, a client Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 71: Example: Mqtt Connect

    1 Control packet type 0x10 byte 2 Remaining length 0x10 CONNECT packet variable header Protocol name byte 1 Length MSB (0) 0x00 byte 2 Length LSB (4) 0x04 byte 3 0x4D byte 4 0x51 Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 72 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 73: Send A Connect Packet

    13. Click the HEX input tab and type the following (these values are the same values from the table in Example: MQTT connect): 10 10 00 04 4D 51 54 54 04 02 00 3C 00 04 44 49 47 49 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    # Create instance of client with client ID “digitest” mqttc.connect("m2m.eclipse.org", 1883) # Connect to (broker, port, keepalive-time) mqttc.loop_start() # Start networking daemon mqttc.publish("digitest/test1", "Hello, World!") # Publish message to “digitest /test1” topic mqttc.loop_stop() # Kill networking daemon Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    17300) client.loop_forever() # Start networking daemon Note You can easily copy and paste code from the online version of this guide. Use caution with the PDF version, as it may not maintain essential indentations. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    # Change this to the COM port your XBee Cellular module is using. # Linux, this will be /dev/ttyUSB# comport = 'COM44' # This is the default serial communication speed of the XBee Cellular # module comspeed = 115200 Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 77 # Exit the thread to avoid a loop of 0-byte receptions else: print("Received {} bytes from client via socket.".format(len (data))) print("Sending payload to modem...") bytes_wr = ser.write(data) # Write payload to modem via UART/serial print("Wrote {} bytes to modem".format(bytes_wr)) def main(): Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 78 This is represented in the figure above. The proxy script needs to be running before running an MQTT publish or subscribe script. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 79 If you try to start the proxy script after starting the subscribe script, you may also see a socket error. To avoid these errors, it is best to start the scripts in the correct order: proxy, then subscribe, then publish. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 80: Update The Firmware

    You should update your XBee to the latest firmware to take advantage of all the latest fixes and features. Refer to the topics below for information about the available update methods. Digi strongly recommends that you devise a plan to update the firmware after initial deployment. For more information, see Create a plan for device and cellular component firmware updates.
  • Page 81 Update the firmware Create a plan for device and cellular component firmware updates If the XBee firmware is updated over-the-air using Digi Remote Manager: After the new firmware image has been downloaded and validated, the XBee modem reboots automatically to install the firmware. The XBee then resets into the new firmware once the update is complete, which may take up to 60 seconds.

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

    Upgrading the cellular component firmware requires USB Direct, which is accessible using an XBIB-CU-TH development board or from your board design. Prerequisites Windows PC Digi XCTU version 6.5.6 or newer. You should upgrade XCTU to the latest version. The device is added to XCTU. See Add a device to XCTU.
  • Page 83 11. Click OK to continue with the update process. XCTU performs the following: 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 Global LTE-M/NB-IoT User Guide...

  • Page 84: Update The Device Firmware

    North America LTE Cat 1 Support Resources b. Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 Cellular LTE-M/NB-IoT firmware to download the zip file. d. Unzip the file. The file contains either a .ebin or a .gbl file.

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

    Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 Global LTE-M/NB-IoT firmware to download the zip file. d. Unzip the file and locate the .gbl file in the unzipped directory. 2. Send an HTTP SCI request to Remote Manager with the contents of the downloaded .gbl file converted to base64 data.
  • Page 86 8. Send an HTTP SCI request to Remote manager with the path of the .gbl file; see the example below. import base64 import requests # Location of firmware image on Remote Manager firmware_path = '~/XBXC.gbl' # Remote Manager device ID of the device being updated device_id = '00010000-00000000-03526130-70153378' Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 87: Update The Modem Firmware

    (0xDB8A + 0x123456) & 0x3FFF= 0x0FE0 iii. Send the command AT%PFE0. AT%PFE0 b. Send the FR command to reboot and enter into bootloader. Invoke the bootloader with hardware signaling a. De-Assert RTS (pin 16). b. Assert DTR (pin 9). Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 88: Transfer The Firmware To The Device

    2. Transfer each block using the following structure, with block index and CRC16 sent in little endian byte: P [2 bytes for block index] [block data with page size length] [2 bytes for CRC16] Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 89: Use A Host Processor To Update The Device Firmware For Xbee 3 Devices Over Uart

    If an error occurs, ERROR is returned. c. After the command is sent, the radio module resets and automatically enters programming mode. 3. Once the device is in programming (bootloader) mode, configure the local serial port to 115200/8/N/1. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 90: Update The Cellular Firmware

    Update the device and the cellular firmware using XCTU. Method Instructions Firmware Over the Air (Digi Remote Manager) Update the cellular component firmware (FOTA (DRM)) using Remote Manager Update the cellular firmware using the API Update the Telit modem firmware using the...
  • Page 91 Determine the location of the firmware version You must first determine the location of the firmware version to which you want to update. Digi provides updates by hosting them on an FTP server: ftp1.digi.com. If the FTP location is not accessible to your XBee Cellular, such as if you are using a VPN, the files may be retrieved and hosted separately on a server that it can reach.
  • Page 92 4. Select the POST HTTP method option. 5. Copy the full Remote Manager device request you created in the previous step: Form the update request. 6. Paste the copied SCI request into the window below the HTTP Method selection section. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 93: Update The Telit Modem Firmware Using The Tfi Utility

    After the update has been triggered, it may take up to 30 minutes for the update to be applied and for the module to be connected to the network once more. If the XBee is not configured to automatically connect to Digi Remote Manager, you will need to reconnect to Remote Manager to perform validation.
  • Page 94 Update the firmware 1. Install the Telit USB driver. a. Determine your Windows version. b. Navigate to the Digi XBee Global LTE-M/NB-IoT firmware page. c. Click the downloaded file to install it. 2. Download the TFI executable. 3. Ensure that the USB Direct Connect switches are in the correct position.
  • Page 95 When the update completes, the message Done - press any key to close the application displays in the progress window. Note If there is an error message instead of the Done message, contact Digi Tech Support for assistance. f. Click in the window and press Enter to close the dialog.

  • Page 96: Update The Cellular Firmware Using The Api

    If the update fails due to a failure to transfer or to apply the update, the process terminates without having upgraded. In API mode a modem status value 0x36 (Cellular component update failed) is sent. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 97: Hardware

    Digi XBee 20-pin through-hole SIM size 4FF Nano Cellular RF characteristics The following table provides the RF characteristics for the device. Specification Value Transmit power Up to 23 dBm, Power Class 3 Receive sensitivity -105 dBm Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 98: Bluetooth Rf Characteristics

    LTE Cat M1 NB/IoT ME310G1-WW Band 12 (700 Band 71 (600 (1900 MHz) MHz) MHz) Band 28 (700 Band 12 (700 MHz) MHz) (1800 Band 13 (700 Band 28 (700 Mhz) MHz) MHz) B5 (850 Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 99 MHz) Band 28 (700 Band 86 MHz) Band 12 (700 Band 13 (700 MHz) MHz) Band 28 (700 Band 85 (700 MHz) MHz) Band 13 (700 Band 20 (800 MHz) MHz) Band 85 (700 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 100: Power Requirements

    Power requirements The following table provides the power requirements for the device. Note The 2G fallback option is not applicable for low-power variants. For a list of low-power variants, see Applicable firmware and hardware. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 101: Power Consumption

    Units VCCMAX Maximum limits of VCC line (VCC - 0.15 VDD_IO Internal VCC or 3.3 V) or 3.3 V, supply whichever is voltage for whichever is lower lower Other XBee -0.3 VDD_IO + pins Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 102 Pin 6 is 5 V tolerant even when the XBee is not powered. We recommend only driving this pin with 3.3 V for compatibility with other XBee products. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 103 Hardware Technical specifications protection peut entraîner des dommages permanents à l'appareil et/ou aux autres appareils connectés ! Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 104: Regulatory Approvals

    Declaration ID: D042514 Bluetooth QDID: 121268 Receiver is category 2 Mechanical drawings The following figures show the mechanical drawings for the XBee. All dimensions are in inches. For XBee header information, see XBee header connector requirements. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 105: Pin Signals

    Direct D+ line / I2C SDA See the I2C note below for more I2C_SDA information. USB D- USB Direct D- line DTR / SLEEP_RQ/ Either Disabled Pin Sleep Control Line or Digital I/O 8 DIO8 Ground Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 106: Pin Connection Recommendations

    Pin connection recommendations The recommended minimum pin connections are VCC, GND, DIN, DOUT, RTS, DTR and RESET. Firmware updates require access to these pins. XBee header connector requirements The XBee header connectors require the following attributes: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 107: Sim Card

    Often, small antennas are desirable, but may come at the cost of reduced range and efficiency. Bluetooth and cellular antennas 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 Global LTE-M/NB-IoT User Guide...

  • Page 108: Gnss Antennas

    Navigation -155 dBm Cold start -144 dBm TTFF Not available Warm <30 s GNSS Simulator test @-130 dBm Cold <30 s GNSS Simulator test @-130 dBm Min Navigation update rate 1 Hz <2 m Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 109: Gnss (Global Navigation Satellite System)

    Sleep is held off when a one-shot/single location acquisition is active. Note The AT command cannot be canceled.  It automatically times out after 120 seconds. GNSS frames The following GNSS frames are available: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

  • Page 111: 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 Global LTE-M/NB-IoT User Guide...

  • Page 112: Clean Shutdown

    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 113: Sim Cards

    The specific failure mode is fretting between the contacts of the SIM card and the card holder. For highest reliability, Digi strongly recommends that you apply a thin layer of dielectric grease to the SIM contacts prior to installing the SIM card. You need only to apply enough dielectric grease that the mating area of the contacts is protected from exposure to air and humidity.
  • Page 114 OFF (left) position, which disconnects pins 7 and 8 of the XBee module from the breakout header and from the inter- integrated circuit (I C) bus. To use I C, the DIP switches must be in the ON (right) position Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 115 WARNING! Battery current discharge rating must be enough to support 5 W or more. WARNING! There is no circuit to prevent over discharge of battery. Battery must contain its own protection circuitry. WARNING! Move UART switches to the OFF position Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 116 XBee to use the serial lines on the breakout connector, when taking current measurements, or when powering the XBIB from the Battery Connector. Grove This connector attaches I C-enabled devices to the development Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 117: 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 C compliant lines. The following picture shows a typical setup: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 118: Uart Communication

    By default, the UART on the XBIB-C-GPS board is active and sends GPS readings once every second. The baud rate of the UART is 9600 baud. For more information about using Micro Python to communicate to the XBIB-C-GPS module, see Class UART. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 119: Associate Led Functionality

    Hardware Associate LED functionality 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 120 Received signal strength (dBm) 79.39% or more -83 dBm or higher 62.42% to -93 to -83 dBm 79.39% 45.45% to -103 to -93 dBm 62.42% Less than -103 dBm, or no cellular network Less than connection 45.45% Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 121 Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 122: Connecting

    Data communication begins when: 1. A socket opens to the remote server. 2. Data is sent. Data connectivity ends when: 1. The server closes the connection. 2. The TM timeout expires (see TM (IP Client Connection Timeout)). Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 123: Disconnecting

    2. The cellular connection is shut down. 3. The cellular component is powered off. Note We recommend performing a safe shutdown before resetting or rebooting the device to allow the cellular module to detach from the network. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 124 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 Global LTE-M/NB-IoT User Guide...

  • Page 125: Select An Operating Mode

    The XBee supports three operating modes: Transparent operating mode, API operating mode, and Bypass operating mode. The default mode is Transparent operating mode. Use the AP (API Enable) command to select a different operating mode. The following flowchart illustrates how the modes relate to each other. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

  • Page 127: Troubleshooting

    My XBee and makes the setting active through AC (Apply Changes). Parameter format Refer to the list of AT commands for the format of individual AT command parameters. Valid formats for hexidecimal values include with or without a leading 0x for example FFFF or 0xFFFF. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 128: Response To At Commands

    When code runs in MicroPython with AP set to a value other than 4, stdout is discarded and there is no input to read on stdin. 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. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 129: Connect The Hardware For Usb Direct Mode

    3. Move both switches to the left position. For more information, see XBIB-CU-TH reference. Note The USB port on the PC should be a minimum of USB 3.0 to supply adequate power, and for the device to work as expected. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 130: Enable Usb Direct Mode

    When in USB direct mode, ATAI returns 0x2B. Note If USB Direct is not enabled (P1 is not set to 7), then setting ATDO to bit 2 and ATP0 6 has no effect on the USB VBUS state. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 131: Configure And Use Ppp With An Xbee 3 Modem

    PPPD by default looks in the /etc/ppp/ directory for an options file and a chat script. The option file configures and specifies the chat script for PPPD. The chat script configures and dials the modem Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 132 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 Global LTE-M/NB-IoT User Guide...
  • Page 133 In file /etc/ppp/options: unrecognized option '/dev/ppp_direct_usb' This indicates pppd could not open up the USB port to the modem. Make sure that the modem is plugged in and shows up under the /dev/ directory as ppp_direct_usb. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 134: Bypass Operating Mode (Deprecated)

    0x2F. It may take a moment for Bypass operating mode to become active. Leave Bypass operating mode To configure a device to leave Bypass operating mode: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 135: Restore Cellular Settings To Default In Bypass Operating Mode

    AI (Association Indication) and confirming that it returns a value other than 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 Global LTE-M/NB-IoT User Guide...

  • Page 136: Sleep Modes

    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 Sleep timer MicroPython sleep behavior Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 137: About Sleep Modes

    SSEL by driving it low wakes the XBee, 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 Global LTE-M/NB-IoT User Guide...

  • Page 138: Sleep Timer

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

  • Page 140: Airplane Mode

    = 0x2C), any mobile-originated activity which requires network connectivity will trigger the cellular component to wake up, including creating a TCP or TLS connection, sending a UDP datagram, or sending an SMS. Typical applications do not need to Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 141 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 142: Psm Behavior

    3. Set the reset offset for the XBee VCC line using the command. The XBee resets and resumes normal operation when the voltage reaches the base threshold set in the command, plus the value of the reset offset set in the command. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 143: 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 enters deep sleep mode, any MicroPython code currently executing is suspended until the device comes out of sleep. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 144: Serial Communication

    UART at 9600 baud and it brings the device up in Command mode on the UART port. You can then send the appropriate commands to the device to configure it for UART operation. If those parameters are written, the device comes up with the UART enabled on the next reset. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 145: Uart Data Flow

    When both the UART and SPI ports are enabled on power-up, all serial data goes out the UART. As soon as input occurs on either port, that port is selected as the active port and no input or output is allowed on the other port until the next device reset. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 146: 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. MicroPython Programming Guide For I C see the Class I2C: two-wire serial protocol section in the for details. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 147: Spi Operation

    Frame Format mode 0 is used. This means CPOL= 0 (idle clock is low) and CPHA = 0 (data is sampled on the clock’s leading edge). The SPI port only supports API Mode (AP = 1). The following diagram shows the frame format mode 0 for SPI communications. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 148: Full Duplex Operation

    During the time that the SPI master is sending invalid data to the SPI slave, it is important no Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 149: Low Power Operation

    SPI mode, there is an option of another sleep pin, as described below. By default, Digi configures DIO8 (SLEEP_REQUEST) as a peripheral and during pin sleep it wakes the device and puts it to sleep. This applies to both the UART and SPI serial interfaces.

  • Page 150: Force Uart Operation

    The XBee sends 0xFF when there is no data to send to the host. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 151: File System

    The directory . refers to the current directory, so the command ATFS ls . lists files in the current directory. Names are case-insensitive, so FILE.TXT, file.txt and FiLe.TxT all refer to the same file. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 152: Secure Files

    SHA256 hash of the file contents. In this way you can validate that the correct file has been placed on the XBee. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 153: Socket Behavior

    API mode behavior for incoming UDP data Transparent mode behavior for outgoing TCP and TLS connections Transparent mode behavior for outgoing UDP data Transparent mode behavior for incoming TCP connections Transparent mode behavior for incoming UDP connections Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 154: Supported Sockets

    The XBee implicitly opens the socket any time there is data to be sent, and closes it according to the timeout settings. The TM (IP Client Connection Timeout) command controls the timeout settings. Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 155: Socket Limits In Api Mode

    2. Set IP to TCP [1] or UDP [0]. 3. Set C0 (Source Port) to the value of the TCP port that the device listens on. 4. Click the Write button Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 156: Api Mode Behavior For Outgoing Tcp And Tls Connections

    Any data received on the UDP socket is sent out the XBee's serial port as a Receive (RX) Packet: IPv4 - 0xB0 frame. A UDP socket is closed when: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 157: Api Mode Behavior For Incoming Tcp Connections

    For Transparent mode, the IP (IP Protocol) setting specifies the protocol and the DL (Destination Address) DE (Destination port) settings specify the destination address used for outgoing data (UDP) and outgoing connections (TCP and TLS). Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 158: Transparent Mode Behavior For Outgoing Udp Data

    DL (Destination Address) (Destination port) settings. If the DL and DE settings are unspecified or invalid, the XBee discards data sent to the serial port. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 159: 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 Global LTE-M/NB-IoT User Guide...

  • Page 160: 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 161: Receive A Socket Create Response

    Receive a Socket Connect 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 Global LTE-M/NB-IoT User Guide...

  • Page 162: 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 Global LTE-M/NB-IoT User Guide...

  • Page 163: Receive Tx Status

    X-Powered-By: Express Access-Control-Allow-Origin: * 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 Global LTE-M/NB-IoT User Guide...

  • Page 164: 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 Global LTE-M/NB-IoT User Guide...

  • Page 165: Receive A Socket Create Response

    The XBee generates a response indicating the status of the request to bind the requested port. Field Value 0xC6 (Socket Bind/Listen Response) Frame type Frame ID 0x01 Socket ID 0x00 Status 0x00 (Success) Socket Bind/Listen Response received from XBee: 7E 00 04 C6 01 00 00 38 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 166: 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 167: 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 168: Close The Socket

    Extended Socket example: TCP Listener The following example demonstrates setting up a TCP listener on the XBee Cellular and interacting with incoming connections. It will open up a listener socket on a given port and then receive data Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 169: Send A Socket Create Frame

    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. Field Value 0x46 (Socket Listen) Frame type Frame ID 0x01 Socket ID 0x00 Source Port 0x2711 (10001) Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 170: Receive A Socket Bind/Listen Response

    Socket ID 0x00 Client Socket ID 0x01 Remote Address 0x0A 0x0A 4A 9D Remote Port 0x27 0x11 Socket New IPv4 Client frame: 7E 00 09 CC 00 01 0A 0A 4A 9D 27 11 FF Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 171: Receiving Data From The New Socket

    7E 00 03 CF 01 07 28 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 Global LTE-M/NB-IoT User Guide...

  • Page 172: Transport Layer Security (Tls)

    For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Specifying TLS keys and certificates Transparent mode and TLS API mode and TLS Key formats Certificate limitations Secure the connection between an XBee and Remote Manager with server authentication Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 173: 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-...

  • Page 174: Transparent Mode And Tls

    The RSA PKCS#1 format is the only common format across XBee Cellular device variants. You can identify a PKCS#1 key file by the presence of BEGIN RSA PRIVATE KEY in the file header. Digi's implementation does not support encrypted keys, we use file system encryption to protect the keys at rest in the system.

  • Page 175: Secure The Connection Between An Xbee And Remote Manager With Server Authentication

    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 176 Verify the that the DI command is set to 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 Global LTE-M/NB-IoT User Guide...
  • Page 177 I/O sampling commands 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 GNSS commands Power measurement commands Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 178: 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 179: Sd (Shutdown)

    Default Cellular commands The following AT commands are cellular configuration and data commands. PH (Phone Number) Reads the SIM card phone number. Parameter range Default Set by the cellular carrier via the SIM card Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 180: S# (Iccid)

    Reads the network operator on which the device is registered. Parameter range MV (Modem Firmware Version) Read the firmware version string for cellular component communications. See the related (Firmware Version) command. Parameter range Default Set in the currently loaded firmware Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 181: Mu (Modem Firmware Revision Number)

    DST start/stop. Note The time is provided by the network. If the time is not what you expect, contact your network provider. Parameter range 0 - 1 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 182: An (Access Point Name)

    BN (Bandmask) (NB-IoT), BM (Bandmask) (LTE-M/NB-IoT), and N# (Preferred Network Technology). Changes to the value only take effect on boot so a reboot or power cycle is required for any changes to become active. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 183: Bm (Bandmask) (Lte-M/Nb-Iot)

    The actual set of enabled bands will be a subset of this bit field, depending on the limitations of the cellular component. 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) LTE Band Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 184: Am (Airplane Mode)

    LTE-M with NB-IoT fallback. Note If this parameter is set when the system is used with a Verizon SIM, the system acts as if only the higher priority value has been selected and fallback does not occur. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 185: Sq (Reference Signal Received Quality)

    RSRQ = -(0xA0 / 0xA) = -16.0 dB If the value cannot be retrieved for some reason, such as the device is not on the network yet, an empty string with OK after it is returned. Parameter range Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 186: Pn (Sim Pin)

    Specifies the password used when authenticating to the cellular network. This command is write-only. Parameter range 1 to 30 ASCII characters A value of a single space character (ASCII 0x20) acts as an empty value. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 187: Ot (Operating Technology)

    Sets or displays the IP protocol used for client and server socket connections in IP socket mode. For TLS, Telit provides the list of supported cipher suites in section 8.1. See SSL/TLS User Guide. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 188: Tl (Tls Protocol Version)

    (Transmit (TX) Request: IPv4 - 0x20 Tx Request with TLS Profile - 0x23 with profile set to 0). Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Format server_cert;client_cert;client_key Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 189: Tls Profile 1)

    Upon the next transmission, the TM value applies to the newly created socket. If you change the TM value while in API Mode, the value only applies to subsequently opened sockets. TM does not apply to explicit sockets. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 190: Ts (Ip Server Connection Timeout)

    Applicable firmware and hardware. The XBee 3 Global LTE-M/NB-IoT device is capable of supporting 2G (GSM/GPRS) fallback when a 3G network is not available. However, connecting to a 2G network draws bursts of current from the power supply in excess of 2.5 A. This may cause host equipment, including the standard XBee development board, to brown out.

  • Page 191: Dx (Requested Edrx Cycle Length)

    AT commands Network commands Bitfield Description Enable Remote Manager Controls whether Remote Manager is enabled. Digi recommends that Remote Manager remains enabled. Enable 2G fallback fallback. Enable USB Direct Set bit 2 to enable USB direct mode. After setting, use...

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

    Response is received. 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 Global LTE-M/NB-IoT User Guide...

  • Page 193: 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 Global LTE-M/NB-IoT User Guide...

  • Page 194: N1 (Dns Address)

    Transparent IP connection is active. In API mode, the address is represented as the binary four byte big-endian numeric value representing the IPv4 address. In Transparent or Command mode, the address is represented as a dotted-quad string notation. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 195: Destination Port)

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

  • Page 196: Ni (Node Identifier)

    Parameter range Standard baud rates: 0x1 - 0xA Non-standard baud rates: 0x4B0 - 0x0EC400 Parameter Description 1200 b/s 2400 b/s 4800 b/s 9600 b/s 19200 b/s 38400 b/s 57600 b/s 115200 b/s 230400 b/s Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 197: Nb (Parity)

    Set or read the number of character times of inter-character silence required before transmission begins when operating in Transparent mode. Set RO to 0 to transmit characters as they arrive instead of buffering them into one RF packet. Parameter range 0 - 0xFF (x character times) Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 198: Td (Text Delimiter)

    0x00 - 0x05 Parameter Description 0x00 API disabled (operate in Transparent mode) 0x01 API enabled 0x02 API enabled (with escaped control characters) 0x03 0x04 MicroPython REPL 0x05 Bypass mode (DEPRECATED. For diagnostic use only) Default Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 199: Ib (Cellular Component Baud Rate)

    AT commands I/O settings commands 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 200: D1 (Dio1/Ad1)

    0 - 6 Parameter Description Disabled SPI_ATTN Digital input Digital output, low Digital output, high C SCL Default D2 (DIO2/AD2) Sets or displays the DIO2/AD2 configuration (pin 18). Parameter range 0 - 5, 6 Description Disabled Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 201: D3 (Dio3/Ad3)

    Analog input Digital input Digital output, default low Digital output, default high MicroPython UART1 CTS Default D4 (DIO4) Sets or displays the DIO4 configuration (pin 11). Parameter range 0, 1, 3 - 5, 7 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 202: D5 (Dio5/Associated_Indicator)

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

  • Page 203: D7 (Dio7/Cts)

    Flow control (output) Digital input Digital output, default low Digital output, default high Default D8 (DIO8/SLEEP_REQUEST) Sets or displays the DIO8/DTR/SLP_RQ configuration (pin 9). Parameter range 0, 1, 3 - 5 Parameter Description Disabled SLEEP_REQUEST input Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 204: D9 (Dio9/On_Sleep)

    This command enables the option of translating incoming data to a PWM so that the output can be translated back into analog form. Parameter range 0 - 6 Parameter Description Disabled RSSI PWM0 output PWM0 output Digital input Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 205: P1 (Dio11/Pwm1 Configuration)

    Digital output, default low Digital output, default high C SDA USB direct Default P2 (DIO12 Configuration) Sets or displays the DIO12 configuration (pin 4). Parameter range 0, 1, 3 - 5, 7 Parameter Description Disabled Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 206: P3 (Dio13/Dout)

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

  • Page 207: Pd (Pull Direction)

    DIO3/AD3 pin 18 DIO2/AD2 DIO1/AD1 pin 19 pin 20 DIO0/AD0 DIO6/RTS pin 16 pin 9 DIO8/SLEEP_REQUEST DIO14/DIN pin 3 DIO5/ASSOCIATE pin 15 DIO9/On/SLEEP pin 13 pin 4 DIO12 pin 6 DIO10 pin 7 DIO11 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 208: M0 (Pwm0 Duty Cycle)

    Displays the temperature of the XBee in degrees Celsius. The temperature value is displayed in 16-bit two’s complement format. For example, 0x1A = 26 °C, and 0xF6 = -10 °C. Parameter range 0 - 0xFF which indicates degrees Celsius displayed in 8-bit two's complement format. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 209: Is (Force Sample)

    Field Size Number of samples 1 byte Digital channel mask 2 bytes Analog chanel mask 1 byte Samples 2 bytes each Parameter range Default Sleep commands The following AT commands are sleep commands. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 210: Sm (Sleep Mode)

    0x1 - 0x83D600 (x 10 ms) Default 0x7530 (5 minutes) ST (Wake Time) Sets or displays the time to spend awake in cyclic sleep modes. Parameter range 0x1 - 0x36EE80 (x 1 ms) Default 0xEA60 (60 seconds) Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 211: Pa (Requested Active Timer)

    Returns the PSM Tracking Area Update Timer value selected by the network, in seconds. The PU command specifies the requested Tracking Area Update Timer value. Note that the network-provided value can be, and often is, different than the requested value. If PSM is disabled Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 212: Command Mode Options

    CN (Exit Command mode) Immediately exits Command Mode and applies pending changes. Note Whether Command mode is exited using the CN command or by CT timing out, changes are applied upon exit. Parameter range Default Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 213: Gt (Guard Times)

    Interact with the XBee using MicroPython. PY is a command with sub-commands. These sub- commands are arguments to PY. Note You can use the PY command options to control MicroPython from Digi Remote Manager. Refer to the Digi MicroPython Programming Guide PYB (Bundled Code Report) You can store compiled code in flash using the os.bundle() function in the MicroPython REPL;...

  • Page 214: Firmware Version/Information Commands

    Reads the firmware version on the device. Parameter range 0 - 0xFFFFF [read-only] Default Set in firmware VL (Verbose Firmware Version) Shows detailed version information including the application build date and time. Parameter range Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 215: Hv (Hardware Version)

    Parameter range Read-only (programmed at manufacturing) Default CK (Configuration CRC) Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. Parameter range 0 - 0xFFFFFFFF Default Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 216: Ai (Association Indication)

    FI (FTP OTA Update Indication) Reports the result of the previous FTP OTA operation. Status code Meaning Last update succeeded. Update file transfer failed. Update image rejected by cellular component. 0x10 A problem processing the update request occurred. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 217: Fo (Ftp Ota Command)

    This can return ERROR immediately if there are invalid parameters set or another FTP OTA already in progress. ATFOC ATFOC clears all parameters back to their defaults as listed in the table above. Example usage Setting a parameter Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 218: Rj (Network Reject Cause)

    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 219: Ci (Protocol/Connection Indication)

    Invalid parameters (bad IP/host). 0x03 TCP not supported on this cellular component. 0x10 Not registered to the cell network. 0x11 Cellular component not identified yet. 0x12 DNS query lookup failure. 0x13 Socket leak 0x20 Bad handle. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 220 Cellular component stack error. 0x12 A modem update is in-progress. Try again after its completion. 0xFF No SMS state to report (no SMS messages have been sent). Parameter range 0 - 0xFF (read-only) Default Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    This action should be used only on CAT 1 modules. If this value is set on an LTE-M module, the result will be as if the value was set to 0. Parameter range Default Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 222: Execution Commands

    If it fails, you see a detailed error message instead of the typical ERROR response for a failing AT command. The response is a named error code and a textual description of the error. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 223: Atfs (File System)

    Similar to the PUT command, but stores the file securely on the XBee.  See Secure files for details on what this means. If the command is incorrect, the reply will be an error as described in Error responses. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 224: Atfs Hash Filename

    BLE commands The following AT commands are BLE commands. BI (Bluetooth Identifier) A human-friendly name for the device. This name appears in BLE advertisement messages. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 225: Bl (Bluetooth Mac Address)

    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 Global LTE-M/NB-IoT User Guide...

  • Page 226: 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 Global LTE-M/NB-IoT User Guide...

  • Page 227: Remote Manager Commands

    Sets or display the fully qualified domain name of the Remote Manager server. Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Range From 0 through 63 ASCII characters. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 228: K1 (Remote Manager Server Send Keepalive)

    $D (Remote Manager certificate) 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. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 229: Dp (Remote Manager Phone Number)

    If available on your device the following metrics are reported: " metrics / signal_strength ": Uncached RSSI signal value. This is the same value as reported by the DB command with parameter 1, in dbM. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 230 Manager for reporting the position data, or consumed directly by the user. Enable reporting of information about the current serving cell. The reported metrics include: Mobile Country Code: metrics/cellular/1/sim1/mcc Mobile Network Code: metrics/cellular/1/sim1/mnc Location Area Code: metrics/cellular/1/sim1/lac Cell ID: metrics/cellular/1/sim1/cid Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 231: Er (Remote Manager Tcp 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 Global LTE-M/NB-IoT User Guide...

  • Page 232: System Commands

    (<CR>). After the last socket ID has been printed the list is terminated with an additional carriage return. In both API and command mode the payload (output) will have the following format: ID<CR> ID<CR> . . . Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 233 The state of the socket: STATE ALLOCATED CONNECTING CONNECTED LISTENING BOUND CLOSING The protocol of the socket: PROTOCOL LOCAL_PORT The local port of the socket. This is 0 unless the socket is explicitly bound to a port. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 234: Gnss Commands

    1 to 0xFFFF Value Description 2D fix enabled. A 2D fix gives only longitude and latitude and needs a minimum of 3 satellites. 3D fix enabled. A 3D fix gives full longitude, latitude, and altitude Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 235: Power Measurement Commands

    XBee recovers from a shutdown state by resetting. You must enable this feature by setting the DO command bit 4. See Low voltage shutdown. Parameter range 0x64 - 0x2BC mV Default 0xC8 mV Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 236: Operate In Api Mode

    Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 237: Api Mode Overview

    Start delimeter Length 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 Global LTE-M/NB-IoT User Guide...

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

    (flagged) so they do not interfere with the data frame sequencing. 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: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 239: Length Field

    API frame: Frame data Length Data 0x7E Data Frame type is the API frame type identifier. It determines the type of API frame and indicates how the Data field organizes the information. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 240: Calculate And Verify Checksums

    FF. 01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F + B8 = 2FF Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 241: Api Frames

    GNSS Start Raw NMEA, Stop Raw NMEA, or One Shot Request - 0x3D GNSS Start Raw NMEA, Stop Raw NMEA, or One Shot Response - 0xBD GNSS Raw NMEA Response - 0xBE GNSS One Shot Response - 0xBF Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 242: At Command - 0X08

    The response for this command is also an AT Command Response frame (0x88). Format The following table provides the contents of the frame. For details on frame structure, see frame format. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    String representation of phone number number terminated with a null (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 Global LTE-M/NB-IoT User Guide...

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

    If there is no matching socket, the TX Status frame returns an error. Protocol Byte 0 = UDP 1 = TCP 4 = SSL/TLS Note For NB-IoT, TCP support is dependent on the Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    Field name value Data type Description Frame type 0x23 Byte Frame ID Byte Reference identifier used to match status responses. 0 disables the TX Status frame. Destination 32-bit big address endian Destination port 16-bit big endian Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 246: At Command Response - 0X88

    Field name value type Description Frame type 0x88 Byte Frame ID Byte Identifies the data frame for the host to correlate with a subsequent ACK. If set to 0, the device does not send a Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    The following table shows the status codes. Code Description Successful transmit 0x20 Connection not found 0x21 Failure to transmit to cell network 0x22 Not registered to cell network 0x2c Invalid frame values (check the phone number) 0x31 Internal error Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 248: Modem Status - 0X8A

    Modem Status - 0x8A Description Cellular component status messages are sent from the device in response to specific conditions. Format The following table provides the contents of the frame. For details on frame structure, see frame format. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    Receive (RX) Packet: IPv4 - 0xB0 Description The XBee uses this frame when it receives RF data on a network socket that is created by a TX request frame or configuring C0 (Source Port). Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 250: User Data Relay - 0X2D

    (internal interface), UART, and BLE. This frame is used in conjunction with User Data Relay Output 0xAD. You can send and receive User Data Relay Frames from MicroPython. See Send and receive User in the MicroPython Programming Guide . Data Relay frames Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 251: Error Cases

    Allows for data to be received on an interface with a designation of the target interface for the data to be output on. The frame can be sent or received from any of the following interfaces: Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 252: Fw Update - 0X2B

    0 (0x01) - Initial request. bit 1 (0x02) - Final request (File fully transferred). bit 2 (0x04) - Cancel request (Used to abort an update in progress). multi- Next section of file being transferred. Payload byte Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 253: Fw Update Response - 0Xab

    The following implementations are known to work with the BLE SRP implementation: https://github.com/cncfanatics/SRP You will need to modify the hashing algorithm to SHA256 and the values of N and g to use the RFC5054 1024-bit group. Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 254 The tables below give more information about the phase of authentication and interpretation of payload data. Phase 1 (Client presents A) If the A value is zero, the server will terminate the connection. Frame data field Offset in frame Length 128 bytes Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 255 The counter for data sent into the XBee API Service is prefixed with the TX nonce value (see the Phase 4 table, above), and the counter for data sent by the XBee to the client is prefixed with the RX nonce value. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    Use this frame to create a new socket with the following protocols: TCP, UDP, or TLS. Format The following table provides the contents of the frame. For details on frame structure, see frame format. Field Field Data name value type Description Frame 0x40 Byte Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 257: Socket Create Response - 0Xc0

    0xFF if the value in the status field is non- zero. Status Byte Status code. See table below. The following table shows the status codes. Code Description Successful open 0x22 Not registered to cell network 0x31 Internal error Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 258: Socket Option Request - 0X41

    Options Option ID Option Name Data Type Default Value Description 0x00 0x00 Determines the TLS Profile Byte TLS profile to be used: $0 - $2. This is valid only for TLS sockets. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 259: Socket Option Response - 0Xc1

    For a UDP socket, this filters out any received responses that are not from the specified remote address and port. Two frames occur in response: Socket Connect Response frame: Arrives immediately and confirms the request. Socket Status frame: Indicates if the connection was successful. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 260: Socket Connect Response - 0Xc2

    A reference identifier used to match status responses. Socket ID Byte ID of the socket that will be connected. Status Byte Status code. See the table below. The following table shows the status codes. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 261: Socket Close - 0X43

    The device sends this frame in response to a Socket Close (0x43) frame. Since a close will always succeed for a socket that exists, the status can be only one of two values: Success or Bad socket Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    Transmit (TX) Status - 0x89 frame is disabled. 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 Global LTE-M/NB-IoT User Guide...

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

    ID for the new connection along with the remote address information. For a UDP socket, this frame binds the socket to a given port. A bound UDP socket can receive data with a Socket Receive From: IPv4 - 0xCE frame. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 264: Socket Listen Response - 0Xc6

    Socket ID Byte The socket ID of the socket that has started listening. Status code. See table below. Status Byte The following table shows the status codes. Code Description 0x00 Success 0x01 Invalid port Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 265: Socket New Ipv4 Client - 0Xcc

    The XBee Cellular modem uses this frame when it receives RF data on the specified socket. Format The following table provides the contents of the frame. For details on frame structure, see frame format. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

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

    Variable Data to be transferred to the destination, up to 1500 bytes. Socket Status - 0xCF Description This frame is sent out the device's serial port to indicate the state related to the socket. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 267: Gnss Start Raw Nmea, Stop Raw Nmea, Or One Shot Request - 0X3D

    Field Field name value Data type Description Frame 0x3D Byte type Reference identifier used to match status Frame ID Byte responses. Using a frame ID of 0 is valid but not recommended. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 268: Gnss Start Raw Nmea, Stop Raw Nmea, Or One Shot Response - 0Xbd

    GNSS Raw NMEA Response - 0xBE Description The device sends this frame whenever it receives a raw NMEA string from the cell modem. Each packet contains a single NMEA sentence. For examples of raw NMEA strings, see http://aprs.gids.nl/nmea/ Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 269: Gnss One Shot Response - 0Xbf

    Longitude in decimal degrees, multiplied by 10 million. Positive Values are East of the Prime Meridian, Negative values are Endian West of the Prime Meridian. Altitude 32-bit Altitude in millimeters. Endian Satellites Byte Total number of satellites in use. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 270: File System Api Frames

    File system API frames Local File System Request - 0x3B Local File System Response - 0xBB Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 271: Local File System Request - 0X3B

    0xFF minus the 8-bit sum of bytes from offset 3 to this byte 8-bit Checksum (between length and checksum). To calculate the checksum, see Calculate and verify checksums. File System Commands Value Command File Open 0x01 0x02 File Close File Read 0x03 File Write 0x04 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 272: File Open - 0X01

    This is useful for protecting MicroPython source code on the device. The SECURE bit is only valid when also setting the WRITE bit and either creating a new file (CREATE + EXCLUSIVE) or replacing an existing file (TRUNCATE). Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 273: File Close - 0X02

    Expires and becomes invalid if not referenced for over 2 minutes. File Size File's size or 0xFFFFFFFF if unknown. 32-bit File Close - 0x02 Description Close an open file and release its File Handle. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 274: File Read - 0X03

    Description Returns a SHA256 hash to verify a file's contents without downloading the entire file. On XBee Cellular modules, there is a response delay in order to calculate the hash of a non-secure file. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 275: File Write - 0X04

    Data to write to file. If empty, frame just refreshes the File 12-n variable Handle timeout to keep the file open. Success Response Offset Size Frame Field Description File System Command File Write - 0x04 8-bit Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 276: Directory Create - 0X10

    4. If the listing is not complete, do one of the following: Send a Directory Read Request to get additional directory entries Send a Directory Close Request to release the Directory Handle. Request Offset Size Frame Field Description 8-bit File System Directory Open 0x10 Command Digi XBee®3 Global LTE-M/NB-IoT User Guide...
  • Page 277 Process the entries in a Directory Open Response or Directory Read Response as follows: Split the File Size and Flags field into separate File Size and Flags. Look for a null terminator after the File Size and Flags field. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 278: Directory Close - 0X12

    (/). Use the Get Path ID request to generate a Path ID for any subdirectory of the file system to allow the use of shorter relative pathnames in later requests. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 279: Delete - 0X2F

    Full Pathname. The Full Pathname will never exceed 255 characters. Delete - 0x2F Description Delete files or a directory. The entry must delete all files in a directory before you can delete the directory. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 280: Volume Info - 0X40

    Description Format the space allocated to file storage. This command sends a Volume Info Success Response when the format completes. Request Offset Size Frame Field Description File System 8-bit Volume Format - 0x4F Command Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 281: Local File System Response - 0Xbb

    System Command. Only present if Status is 0 and the command has additional data to provide. 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 282: Status Values

    Attempt to read past EOF (end of file) 0x57 Hardware failure 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 Global LTE-M/NB-IoT User Guide...

  • Page 283: Regulatory Firmware

    After regulatory testing is complete, you will have to reinstall the device firmware to return to full functionality. The table below shows a list of features that are supported in the regulatory firmware. Feature Description Use XCTU or Digi Remote Manager to upgrade Firmware upgrade the device to or from the regulatory testing firmware. Command mode Use +++ to switch between bypass mode, DTM protocol, and other configurations.

  • Page 284: Install Regulatory Firmware Using Remote Manager

    Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. To perform a firmware update: 1. Download the updated firmware file for your device from Digi's support site. a. Go to the Digi XBee 3 Cellular LTE-M support page.

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

    The Bluetooth DTM protocol is implemented as specified in Volume 6 part F of the Bluetooth 5.4 specification. All commands are two bytes long (16-bits) and receive a response, which is also two bytes long. All multi-byte sequences are big endian. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 286: Bluetooth Dtm Protocol With X1B And Earlier

    1: Packet will be commands. an unmodulated carrier Example Example of a typical test sequence. Description Command Response Set transmit power to 10 dBm 06 28 00 14 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 287: Regulatory Testing Commands

    Prior to enabling test mode, it is recommended that you set the module to factory default settings to ensure best results. When test mode is enabled, the module will report an AI value of 0x31. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 288: Start Test Mode)

    %5 (Start modulated transmit) Use this command to start modulated transmit using the EARFCN and power specified by AT%7 and AT%9. This command works in conjunction with %6 (Stop transmit). Examples Start modulated transmit: AT%5 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 289: Stop Transmit)

    Use this command to get the EARFCN (Absolute Radio Frequency Channel Number) that was set using AT%7. Parameter range Example Get the channel number: AT%8 %9 (Set transmit power) Use this command to set the transmit power. Parameter range 0-FFF hexadecimal Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 290: A (Get Transmit Power)

    AT%8. There are multiple frequency/channel numbering systems. ARFN is ambiguous for a portion of the bands that they specify. This command resolves the overlap and allows for proper selection of the band and technology to test. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 291: I (Get Channel Mapping)

    Value Description 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 Global LTE-M/NB-IoT User Guide...

  • Page 292: Troubleshooting

    Solution 1. Click the Discover radio modules button 2. Select all of the ports to be scanned. 3. Click Next and then Finish. A dialog notifies you of the devices discovered and their details. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 293: Other Possible Issues

    3. If you have a driver installed and updated but still have issues, on Windows 10 you may have to enable VCP on the driver; see Enable Virtual COM port (VCP) on the driver. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 294: Enable Virtual Com Port (Vcp) On The Driver

    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 Global LTE-M/NB-IoT User Guide...

  • Page 295: 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 Global LTE-M/NB-IoT User Guide...

  • Page 296: Unresponsive Cellular Component In Bypass Mode

    3. You SIM card is out of SMS text quota. 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 Global LTE-M/NB-IoT User Guide...

  • Page 297: Network Connection Issues

    APN is set correctly. If you are using a SIM card not provided by Digi, or a SIM card capable of roaming between multiple networks, you may need to adjust the modem’s network configuration. Set...

  • Page 298: Regulatory Information

    FCC notices IMPORTANT: XBee modules have been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091). Modifications not expressly approved by Digi could void the user's authority to operate the equipment.
  • Page 299 Re-orient or relocate the receiving antenna, Increase the separation between the equipment and receiver, Connect equipment and receiver to outlets on different circuits, or Consult the dealer or an experienced radio/TV technician for help. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 300: Antenna Regulatory Information: Fcc And Ised

    For the Global LTE-M/NB-IOT (LowPower) variant: If the antenna is mounted at least 20 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 301: Rf Exposure

    To ensure compliance, operations at closer than this distance are not recommended. The antenna used for this transmitter must not be co-located in conjunction with any other antenna or transmitter. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 302: Fcc Publication 996369 Related Information

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

  • Page 303: Innovation, Science And Economic Development Canada (Ised)

    25 cm à partir de toutes les personnes et ne doit pas être situé ou fonctionner en conjonction avec tout autre antenne ou émetteur. Global LTE-M/NB-IOT (Low Power) Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 304: Transmitters With Detachable Antennas

    For the Global LTE-M/NB-IOT (LowPower) variant: If the antenna is mounted at least 20 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 305 Max gain for ISED (dBi) Band ME310G1-WW ME310G1-W1 (Low Power) GPRS/EGPRS 850 GPRS/EGPRS 1900 FDD 2 FDD 4 FDD 5 FDD 12 FDD 13 FDD 25 11.0 FDD 26 FDD 66 FDD 71 FDD 85 Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 306: European Union (Eu)

    For the Global LTE-M/NB-IOT (LowPower) variant: If the antenna is mounted at least 20 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 307 11.33 14.33 FDD 8 8.45 11.45 FDD 20 8.20 11.20 FDD 28 7.47 10.47 FDD 31 FDD 72 Cellular antenna: RED antenna type Antenna type Model ME310G1-WW Omnidirectional Antenna Gain 2.14 dBi ME310G1-W1 (Low Power) Digi XBee®3 Global LTE-M/NB-IoT User Guide...

  • Page 308: United Kingdom (Ukca)

    Brazilian standards. Modelo: XB3M1, XB3M2, XB3M3 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. Digi XBee®3 Global LTE-M/NB-IoT User Guide...

This manual is also suitable for:

Xb3-c-gms-ut-001Xb3-c-gm2-ug-101Xb3-c-gm2-ut-102Xb3-c-gm1-ut-001Xb3-c-gm1-ut-101Xb3-c-gm1-ut-102

Table of Contents