Page 1 Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 2: Customer Support
Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
Page 3 To provide feedback on this document, email your comments to techcomm@digi.com Include the document title and part number (Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide, 90002253 K) in the subject line of your email. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 4: Table Of Contents
Contents Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide Applicable firmware and hardware SIM cards Get started with the XBee Smart Modem Identify the kit contents Connect the hardware Install and upgrade XCTU Add a device to XCTU...
Page 5 CoAP terms CoAP quick start example Configure the device Example: manually perform a CoAP request Example: use Python to generate a CoAP message Get started with MQTT Example: MQTT connect Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 6 Update the firmware using web services in Remote Manager Use a host processor to update the modem firmware for XBee 3 devices over UART prior to Use a host processor to update the device firmware for XBee 3 devices over UART after *10...
Page 7 Leave Bypass operating mode Restore cellular settings to default in Bypass operating mode USB direct mode Enable USB direct mode Configure and use PPP with a Digi XBee 3 Cellular CAT 1 AT&T modem Command mode Enter Command mode Troubleshooting Send AT commands...
Page 8 API mode behavior for outgoing TCP and TLS connections API mode behavior for outgoing UDP data API mode behavior for incoming TCP connections API mode behavior for incoming UDP data Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 9 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 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 10 DE (Destination port) C0 (Source Port) LA (Lookup IP Address of FQDN) Serial interfacing commands BD (Baud Rate) NB (Parity) SB (Stop Bits) RO (Packetization Timeout) TD (Text Delimiter) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 11 Diagnostic interface commands DI (Remote Manager Indicator) CI (Protocol/Connection Indication) AS (Active scan for network environment data) Execution commands NR (Network Reset) !R (Modem Reset) File system commands Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 12 Transmit (TX) SMS - 0x1F Transmit (TX) Request: IPv4 - 0x20 Tx Request with TLS Profile - 0x23 AT Command Response - 0x88 Transmit (TX) Status - 0x89 Modem Status - 0x8A Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 13 Solution Error Failed to send SMS Solution Baud rate in Bypass mode Regulatory information Modification statement Interference statement FCC Class B digital device notice RF exposure FCC notices Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 14 FCC-approved antennas Bluetooth antennas Cellular antennas FCC publication 996369 related information Labeling requirements for the host device Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 15: Digi Xbee® 3 Cellular Lte Cat 1 At&T Smart Modem User Guide
This manual uses the placeholder value "xx" in the firmware versions listed above, as the manual documents the released features as of the time of its writing. Digi International periodically releases new firmware containing bug fixes and new features. As new firmware is released and distributor stock is refreshed, the new firmware will gradually become available without the need to update.
Page 16: Get Started With The Xbee Smart Modem
XBee to enable you to do edge-computing by adding business logic in MicroPython, rather than using external components. Example: hello world Example: turn on an LED Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 17: Identify The Kit Contents
One 12 V power supply Two cellular antennas with U.FL connectors One USB cable One XBee Smart Modem Note The XBee Smart Modem comes attached to the board in ESD wrap. One SIM card Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 18: Connect The Hardware
5. Connect the USB cable from a PC to the USB port on the development board. The computer searches for a driver, which can take a few minutes to install. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 19: Install And Upgrade Xctu
Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices. XCTU does not work directly over an SPI interface.
Page 20: Update The Device And Cellular Firmware Using Xctu
Update the device and cellular firmware using XCTU You should use XCTU to update the device firmware on your XBee 3 to the most recent version. This ensures that you can take advantage of all the latest fixes and features. XCTU will update the device firmware, and if needed, XCTU will attempt to update your cellular firmware.
Page 21 The XBee Cellular kit includes six months of free cellular service. Six months of free cellular service assumes a rate of 5 MB/month. If you exceed a limit of 30 MB during the six month period your SIM will be deactivated. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 22 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 Software libraries Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 23: Xbee Connection Examples
For instructions on using the Console, see the AT console topic in the XCTU User Guide. 10. Click the Open button to open a serial connection to the device. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 24 11. Click in the left pane of the Console log, then type in the Console to talk to the echo server. The following screenshot provides an example of this chat. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 25: Connect To The Eliza Server
10. Click in the left pane of the Console log, then type in the Console to talk to the ELIZA Therapist Bot. The following screenshot provides an example of this chat with the user's text in blue. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 26 XBee connection examples Connect to the ELIZA server Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 27: Connect To The Daytime Server
11. Click in the left pane of the Console log, then type in the Console to query the Daytime server. The following screenshot provides an example of this chat. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 28 XBee connection examples Connect to the Daytime server Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 29: Send An Sms Message To A Phone
For instructions on using the Console, see the AT console topic in the XCTU User Guide. 10. Click the Open button to open a serial connection to the device. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 30 XBee Smart Modem with the PH command. 13. On the phone, reply with the text connect with confidence and the XBee Smart Modem outputs this reply from the UART. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 31: Perform A (Get) Http Request
Note The HTTP protocol requires an empty line (a line with nothing preceding the CRLF) to terminate the request. 15. Click Add packet. 16. Click the Open button Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 32 XBee connection examples Perform a (GET) HTTP request 17. Click Send selected packet. 18. A GET HTTP response from httpbin.org appears in the Console log. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 33: Connect To A Tcp/Ip Address
Software libraries One way to communicate with the XBee device is by using a software library. The libraries available for use with the XBee Smart Modem include: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 34 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 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 35 Example: hello world Example: turn on an LED Example: code a request help button Example: debug the secondary UART Exit MicroPython mode Other terminal programs Use picocom in Linux Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 36: Get Started With Micropython
. We recommend using flow control to avoid data loss, especially when pasting large amounts of code/text. 5. Put the XBee Smart Modem into MicroPython mode, in the AP field select MicroPython REPL [4] and click the Write button Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 37: Use The Micropython Terminal In Xctu
1. Note the DS4 LED on the XBIB board. The following image highlights it in a red box. The LED is normally off. Other terminal programs if you do not use the MicroPython Terminal in XCTU. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 38: Example: Code A Request Help Button
This example provides a fast, deep dive into MicroPython designed to let you see some of the powerful things it can do with minimal code. It is not meant as a tutorial; for in-depth examples refer to the Digi Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 39: Enter Micropython Paste Mode
Many stores have help buttons in their aisles that a customer can press to alert the store staff that assistance is required in that aisle. You can implement this type of system using the Digi XBee Smart Modem, and this example provides the building blocks for such a system. This example, based on SMS...
Page 40 PDF version, as it may not maintain essential indentations. Note If you have problems pasting the code, see Syntax error at line 1. For SMS failures, see Error Failed to send SMS. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 41: Send A Text (Sms) When The Button Is Pressed
PDF version, as it may not maintain essential indentations. Note If you have problems pasting the code, see Syntax error at line 1. For SMS failures, see Error Failed to send SMS. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 42: Add The Time The Button Was Pressed
Handle error if it occurs. try: c.sms_send(ph, 'Button Pressed at: ' + str(buf)) print("Sent SMS successfully.") except OSError: print("ERROR- failed to send SMS.") # Exit the WHILE loop. break Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 43: Example: Debug The Secondary Uart
, change AP API Enable to another mode and click the Write button . We recommend changing to Transparent mode [0], as most of the examples use this mode. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 44: Other Terminal Programs
Stop: 1 bit Flow control: hardware Transmit delay: N/A 7. Click OK to apply the changes to the serial port settings. The settings should go into effect right away. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 45: Use Picocom In Linux
Modem. 4. In this case, replace /dev/ttyUSB0 at the top with /dev/ttyUSB<number>, where <number> is the new number that appeared. 5. It should connect and show Terminal ready. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 46 Get started with MicroPython Use picocom in Linux Now you can type MicroPython commands at the >>> prompt. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 47: Get Started With Ble
(client) device. If your device is updated to the most recent firmware, BLE enables you to connect your XBee (client) to another (server) device. The latest Digi XBee products include a dual- mode radio that allows the device to communicate through the BLE interface and the RF/Cellular network at the same time.
Page 48: Enable Ble On An Xbee Device
Before you begin, you should determine the password you want to use for BLE on the XBee device and store it in a secure place. Digi recommends a secure password of at least 8 characters and a random combination of letters, numbers, and special characters. Digi also recommends using a security management tool such as LastPass or Keepass for generating and storing passwords for many devices.
Page 49: 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 50: Ble Reference
BLE reference 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. All nearby devices with BLE enabled are displayed in a list. 3. Scroll through the list to find your XBee device.
Page 51: Api Request Characteristic
Response data will be presented through indications on this characteristic. Indications are acknowledged and re-transmitted at the BLE link layer and application layer and provides a robust transport for this data. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 52: Get Started With Digi Remote Manager
Get started with Digi Remote Manager Digi Remote Manager® is a cloud-based device and data management platform that you can use to configure and update a device, and view and manage device data. The sections below describe how to create a Remote Manager account, upgrading your device, configure your device, and manage data in Remote Manager.
Page 53: Create A Remote Manager Account
Create a Remote Manager account and add devices Create a Remote Manager account Digi Remote Manager is an on-demand service with no infrastructure requirements. Remote devices and enterprise business applications connect to Remote Manager through standards-based web services. This section describes how to configure and manage an XBee using Remote Manager. For...
Page 54: Verify The Connection Between A Device And Remote Manager
The following provides a template of how to create a schedule for an XBee to connect, perform a set of tasks and then disconnect: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 55: Examples
9. Click Run Now. Examples The examples in the following sections assume you are using the Digi Remote Manager Schedule wizard. However, you should be aware that operations can be created and performed programmatically via web service calls or via the API explorer. The XML web service calls provide more options than are available in the GUI dashboard for some tasks.
Page 56: Example: Configure A Device From Remote Manager Using Xml
Schedule walk-through feature in the Digi Remote Manager® User Guide more information. 4. In the Description field, enter a name for the schedule, such as "Configure Reporting Frequency." Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 57: Example: Schedule A Task To Update The Device Firmware Using Remote Manager
Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 Cellular LTE CAT 1 firmware release to download the zip file. d. Unzip the file. The file contains either a .ebin or a .gbl file.
Page 58: Example: Update Micropython From Remote Manager Using Xml
Click Create. The new file is added to the list of files. d. Find the "MicroPython" folder in the folder list. e. Click Upload Files. The Upload Files dialog displays. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 59 <name>RCI Command</name> <event> <on_error> <continue/> </on_error> </event> <sci> <send_message cache="false" allowOffline="true" >  <rci_request> <set_setting> <micropython> <PS>0</PS> </micropython> Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 60 </command> <command> <name>Upload Files</name> <event> <on_error> <continue/> </on_error> </event> <sci> <file_system allowOffline="true" > <commands> <put_file path="/flash/lib/uftp.py"> <file>~/MicroPython/uftp.py</file> </put_file> </commands> </file_system> </sci> </command> <command> <name>RCI Command</name> <event> <on_error> <continue/> Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 61 3. Click SCI Targets. The Select devices to be used in examples dialog appears. a. From the Add Targets list box, search for the IMEI (device ID) of the device that you want to update. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 62: Manage Data In Remote Manager
7. Click on the status group that has information you want to display. The status information is related to AT commands. For information about each AT command in the categories, click on the appropriate link below. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 63: Manage Secure Files In Remote Manager
5. Select the device that you want to configure. 6. Click Properties in the toolbar. As an alternative, double-click on the device name. The Properties page appears. 7. Click File Management. The File Management view appears. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 64: Remote Manager Reference
Example: Schedule a task to update the device firmware using Remote Manager. Note If you wish to restore the persistent connection behavior that was the default in prior firmware versions, see Restore persistent connection to a remote XBee. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 65 <rci_request> <set_setting> <remote_manager> <MO>7</MO> </remote_manager> </set_setting> </rci_request> 7. Click Schedule in the lower right corner of the dialog to schedule the tasks to run. The schedule screen displays. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 66: Disconnect
6. Click Config in the toolbar to display the settings sub-menus. 7. Click on the settings category that you want to configure. The settings in that category appear. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 67 Request connect feature in Remote Manager. Digi Remote Manager is enabled on the XBee by default and has a 60 second keepalive interval, which can result in excessive cellular data usage, depending on your plan. The commands can be used to tune the keepalive interval. Your carrier will disconnect an inactive socket automatically if there is no activity, so you need to tune this value based on your carrier’s disconnect timeout.
Page 68 (international) code, you can re-configure the device using the DP (Remote Manager Phone Number) RI (Remote Manager Service ID) commands. 10. Click Save. 11. When all changes are complete, disconnect the device from Remote Manager. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 69: Examples: Iot Protocols With Transparent Mode
The following examples provide some additional scenarios you can use to get familiar with the XBee. If you are interested in using the intelligence built into the XBee, see Get started with MicroPython. Get started with CoAP Get started with MQTT Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 70: Get Started With Coap
The following diagram shows the message format for the CoAP protocol; see ISSN: 2070-1721 details: This is an example GET request: 44 01 C4 09 74 65 73 74 B7 65 78 61 6D 70 6C 65 Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 71: Configure The Device
AI value. Example: manually perform a CoAP request Follow the steps in Configure the device prior to this example. This example performs the CoAP GET request: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 72: Example: Use Python To Generate A Coap Message
HTTP protocol and how to do this using the XBee Smart Modem. In this example, the XBee Smart Modem talks to a CoAP Digi Server. You can use this client code to provide an abstract wrapper to generate a CoAP message that commands the XBee Smart Modem to talk to the remote CoAP server.
Page 73 In the following figure, the payload contains the server response to the query. It shows the results for when you press Enter rather than Y. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 74: Get Started With Mqtt
Description Hex value CONNECT packet fixed header byte 1 Control packet type 0x10 byte 2 Remaining length 0x10 CONNECT packet variable header Protocol name Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 75 Keep Alive How often the client pings the broker to keep the connection alive; in this example it is set to 60 seconds. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 76: Send A Connect Packet
The length of the ID (in bytes) precedes the ID itself. Each client connecting to a broker must have a unique client ID. In the example, the ID is DIGI. When using the Paho MQTT Python libraries, a random alphanumeric ID is generated if you do not specify an ID.
Page 77: Example: Send Messages (Publish) With Mqtt
A basic Python example of a node publishing (sending) a message is: mqttc = mqtt.Client("digitest") # Create instance of client with client ID “digitest” mqttc.connect("m2m.eclipse.org", 1883) # Connect to (broker, port, keepalive-time) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 78: Example: Receive Messages (Subscribe) With Mqtt
# Define callback function for successful connection client.on_message = on_message # Define callback function for receipt of a message # client.connect("m2m.eclipse.org", 1883, 60) # Connect to (broker, port, keepalive-time) client.connect('127.0.0.1', 17300) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 79: Use Mqtt Over The Xbee Cellular Modem With A Pc
""" This function sets up the variables needed, including the serial port, and it's speed/port settings, listening socket, and localhost adddress. """ Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 80 - socket has closed. Exiting socket reader thread.") return 1 # Exit the thread to avoid a loop of 0-byte receptions else: print("Received {} bytes from client via socket.".format(len (data))) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 81 MQTT client to use the data connection provided by the device. Think of the proxy script as a translator between the MQTT client and the XBee Smart Modem. The following figure shows the basic operation. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 82 To avoid these errors, it is best to start the scripts in the correct order: proxy, then subscribe, then publish. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 83: 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 84: Create A Plan For Device And Cellular Component Firmware Updates
USB Direct functionality, either by designing in a USB port and options for enabling and disabling USB Direct, or by allowing the XBee 3 cellular modem to be removed from its socket and placed on a development board, such as the Digi XBIB-CU-TH.
Page 85: Update The Device And The Cellular Firmware Using Xctu
The device is added to XCTU. See Add a device to XCTU. Digi XBIB-CU-TH development board, or your own hardware which enables USB Direct access USB cable for USB Direct access is connected to the PC Cellular component USB drivers are installed To update the device and cellular firmware: 1.
Page 86 XCTU applies and updates the device firmware. If the cellular firmware is being updated, XCTU reconfigures the XBee for USB Direct access and updates the new cellular firmware on the device. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 87: Update The Device Firmware
Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 Cellular LTE CAT 1 firmware release to download the zip file. d. Unzip the file. The file contains either a .ebin or a .gbl file.
Page 88: Update The Firmware Using Web Services In Remote Manager
Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 Cellular LTE CAT 1 firmware release to download the zip file. d. Unzip the file and locate the .gbl file in the unzipped directory.
Page 89 6. Click Upload Files; browse and select the *.gbl firmware file to upload it. 7. Send an HTTP SCI request to Remote manager with the path of the .gbl file; see the example below. import base64 import requests Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 90: Use A Host Processor To Update The Modem Firmware For Xbee 3 Devices Over Uart Prior To
Use a host processor to update the modem firmware for XBee 3 devices over UART prior to *10 This process explains how to update the modem firmware for XBee 3 Cellular devices with a modem firmware version prior to *10 (11410 and 31010).
Page 91 If the bootloader does not answer to this command, remain at the current rate. 6. Send the I command (initialization command). This command erases the current firmware from the device. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 92: Use A Host Processor To Update The Device Firmware For Xbee 3 Devices Over Uart After *10
Use a host processor to update the device firmware for XBee 3 devices over UART after *10 This process explains how to update the device firmware for XBee 3 Cellular devices over UART with a firmware version after *10. Update the modem firmware 1.
Page 93 A power cycle or reset event occurs during the firmware load. A file error or a flash error occurs during the firmware load. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 94: Update The Cellular Firmware
Customers must apply both upgrades. Applying only the first upgrade without the second will result in a product that is on an intermediate version not intended for production use. These upgrade files are hosted on ftp1.digi.com under the directory support/telit. See Determine the location of the firmware version.
Page 95 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 96 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 97: Update The Telit Modem Firmware Using The Xfp Utility
You can update the Telit LE866A1-NA cellular modem firmware on the device. Note To update the Telit modem firmware on the XBee 3 Cellular Cat 1 device you must use Direct mode. USB Direct mode requires that you use either a Digi XBIB-CU-TH development board or your own hardware that makes a USB port available to a PC.
Page 98 4. Configure the device for USB Direct access. Connect the USB Type-C cable to the USB port on the bottom edge of the development board. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 99 Click OK to dismiss the first dialog box. The Xfp dialog displays. e. From the Port drop-down box, select USB. f. Click Browse to find and select the Telit modem firmware image: generic_stream_ LE866A1-NA_23.00.306.bin Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 100 Scroll down to the I/O Settings section, and find the P1 DIO11 option. e. Set the P1 DIO11 option back to the desired setting. The default value is Disabled [0]. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 101: Technical Specifications
Technical specifications Interface and hardware specifications RF characteristics Networking specifications Power requirements Power consumption Electrical specifications Regulatory approvals Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 102: Interface And Hardware Specifications
Power requirements The following table provides the power requirements for the device. Specification Value Supply voltage range 3.0 to 5.5 VDC Extended voltage range 2.7 to 5.5 VDC Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 103: Power Consumption
Internal supply While in deep sleep and (VCC- voltage for I/O during initial power up 0.3, 3.3) VDD_IO Internal supply In normal running mode 3.3 V voltage for I/O Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 104: Regulatory Approvals
Pin 6 is also 5 V tolerant even when the XBee Smart Modem is not powered. We recommend only driving this pin with 3.3 V for compatibility with other XBee products. The VBUS line is not used to enable/disable USB on this product. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 105 Technical specifications Regulatory approvals Specification Value Declaration ID: D042514 Bluetooth QDID: 121268 Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 106: Hardware
Hardware Mechanical drawings Pin signals RSSI PWM SIM card Associate LED functionality Development boards Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 107: Mechanical Drawings
Hardware Mechanical drawings Mechanical drawings The following figures show the mechanical drawings for the XBee Smart Modem. All dimensions are in inches. Pin signals The pin locations are: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 108: Pin Connection Recommendations
DIO12/SPI_MISO and DIO4/SPI_MOSI (pin 4 and pin 11) may optionally be configured as a secondary UART serial port using MicroPython. See the Digi MicroPython Programming Guide for details. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 109: Rssi Pwm
The following table describes the Associate LED functionality. For the location of the Associate LED on the XBIB-U development board, see number 6 on the XBIB-U-DEV reference. Blink LED status timing Meaning On, solid Not joined to a mobile network. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 110 Where the low signal means LED off and the high signal means LED on. When CI is not 0 or 0xFF, the Associate LED has a different blink pattern that looks like this: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 111: Development Boards
Hardware Development boards Development boards XBIB-U-DEV reference This picture shows the XBee USB development board and the table that follows explains the callouts in the picture. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 112 Powering the board with J2 and J5 without R31 removed can cause shorts if the USB or barrel plug power are connected. Applying too high a voltage destroys electronic circuitry in the device and other board components and/or can cause injury. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 113: Xbib-Cu-Th Reference
Development boards XBIB-CU-TH reference This picture shows the XBee-CU-TH development board and the table that follows explains the callouts in the picture. Note This module is sold separately. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 114 USB-C connector is not powering the UART. Note Power supply outputs 3.3V to XBee regardless of input voltage as long as current requirement can be met to achieve power consumption of devices. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 115 USB micro port for correct operation of the I2C sensor. XBee Socket This is the socket for the XBee (TH form factor). XBee Test Allows easy access to pins 1 to 20 of the XBee. Point Pins Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 116: Xbib-C-Gps Reference
This GPS module is sold separately and requires an XBIB-CU-TH development board. Note You run a demo using MicroPython to parse UART to GPS communications. see Run the MicroPython GPS demo. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem 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 I2C compliant lines. The following picture shows a typical setup: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 118 For more information about using Micro Python to communicate to the XBIB-C-GPS module, see Class UART. Run the MicroPython GPS demo The Digi MicroPython github repository contains a GPS demo program that parses the GPS NMEA data from the UART and prints them. Note If you are unfamiliar with MicroPython on XBee, see Get started with MicroPython.
Page 119: Antenna Recommendations
You must connect the primary port and the secondary port is optional. The secondary antenna improves receive performance in certain situations. Digi recommends it for best results. FCC-approved antennas for a list of approved antennas. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 120: Keepout Area
Bluetooth. Do not mount the surface-mount PCB antenna module on the RF Pad footprint because that footprint requires a ground plane within the keepout area. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 121: Through-Hole Keepout
For optimal cellular reception, keep the antenna as far away from metal objects and other electronics (including the XBee Smart Modem) as possible. Often, small antennas are desirable, but come at the cost of reduced range and efficiency. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 122 Power supply considerations Recommended application circuit Heat considerations and testing Heat sink guidelines Add a fan to provide active cooling Custom configuration: Create a new factory default Clean shutdown Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 123: Design Recommendations
(~0.5 W) and heavy load (~3 W). Recommended application circuit In high EMI noise environments, we recommend adding a 10 nF ceramic capacitor very close to pin 5. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 124: Heat Considerations And Testing
AVG,test is the average current draw expected for your application when transmitting at maximum RF power; see Power consumption. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 125: Heat Sink Guidelines
We recommend that you perform sufficient testing, as explained in Heat considerations and testing, to ensure that the XBee Smart Modem does not exceed temperature specifications. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 126: Add A Fan To Provide Active Cooling
The custom configuration is stored in non-volatile memory. You can continue to create and save custom configurations until the device's memory runs out of space. If there is no space left to save a configuration, XBee returns an error. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 127: Set A Custom Configuration
3. Issue AT!C. Clean shutdown 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. Failure to shutdown properly has the potential to result in delays resuming network operation and in some rare instances may result in an unrecoverable module failure.
Page 128: Sleep Feature
Change the XBee configuration to use Airplane mode (AM=1). This puts the XBee into a safe state for shutdown. 1. Set AM=1. 2. Apply configuration change. 3. Wait 30 seconds to allow time for shutdown to occur. 4. Power off the device. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 129: Cellular Connection Process
Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 130: Connecting
3. The cellular network may also close the connection after a timeout set by the network operator. Disconnecting When the XBee Smart Modem is put into Airplane mode, deep sleep is requested, or ATSD (shutdown) command is executed: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 131 3. The cellular component is powered off. Note We recommend entering Airplane mode before resetting or rebooting the device to allow the cellular module to detach from the network. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 132: Modes
Modes Select an operating mode Transparent operating mode API operating mode Bypass operating mode (DEPRECATED) USB direct mode Command mode MicroPython mode Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 133: Select An Operating Mode
Bypass operating mode. The default mode is Transparent operating mode. Use the AP (API Enable) command to select a different operating mode. The following flowchart illustrates how the modes relate to each other. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 134: Transparent Operating Mode
Bypass operating mode (DEPRECATED) WARNING! Bypass mode is now deprecated and is not recommended for new designs. XBee 3 Cellular products support direct USB to access the cellular modem directly. See direct mode for details on how to configure your XBee to use direct USB.
Page 135: Enter Bypass Operating Mode
Send AT&F1 to reset the cellular component to its factory profile. USB direct mode Note In order to use USB direct mode in Digi XBee development kits, you must use the XBIB-CU-TH development board. Note You should use this mode if you want to connect using PPP through the cellular modem while using a host operating system, such as embedded Linux.
Page 136: Configure And Use Ppp With A Digi Xbee 3 Cellular Cat 1 At&T Modem
USB direct mode Configure and use PPP with a Digi XBee 3 Cellular CAT 1 AT&T modem Your XBee 3 Cellular device can communicate directly with the modem and can drop into PPP mode. Prerequisites A working SIM card to get onto the network.
Page 137 ABORT 'NO CARRIER' '' AT OK AT&K3 OK ATE0 OK AT+CGDCONT=1,"IP","<APN>" OK AT&S0 OK ATD*99***1# CONNECT Step 4: Run PPPD PPPD is the program that brings up the PPP interface. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 138 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. Error after running "ping www.digi.com" ping: unknown host www.digi.com Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 139: Command Mode
Both of these methods temporarily set the device's baud rate to 9600 and return an OK on the UART to indicate that Command mode is active. When Command mode exits, the device returns to normal operation at the baud rate that BD is set to. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 140: Send At Commands
For example, if you send the BD command to change the baud rate, the actual baud rate does not change until you apply the changes. To apply changes: 1. Send AC (Apply Changes). 2. Send (Write). Exit Command mode. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 141: Make Command Changes Permanent
When code runs in MicroPython with AP set to a value other than 4, stdout goes to the bit bucket and there is no input to read on stdin. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 142: Sleep Modes
Sleep modes About sleep modes Normal mode Pin sleep mode Cyclic sleep mode Cyclic sleep with pin wake up mode The sleep timer MicroPython sleep behavior Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 143: About Sleep Modes
Upon entering deep sleep mode, the XBee Smart Modem closes any active UDP connections and turns off the cellular component. As a result, any sockets that were opened in MicroPython prior to sleep Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 144 (b'', (<address from connect()>, <port from connect()>) ) The underlying UDP socket resources have been released at this point. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 145: Power Saving Features And Design Recommendations
Power saving features and design recommendations Airplane mode Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 146: Airplane Mode
XBee Smart Modem is fully turned off and no access to the cellular network is performed or possible. Use AM (Airplane Mode) to configure this mode. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 147: Serial Communication
Serial communication Serial interface Serial data UART data flow Serial buffers CTS flow control RTS flow control Enable UART or SPI ports Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 148: Serial Interface
The serial transmit buffer collects the data it receives via the RF link until it transmits that data out the serial or SPI port. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 149: Cts Flow Control
If both ports are disabled on reset, the device uses the UART in spite of the wrong configuration so that at least one serial port is operational. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 150: Spi Operation
SPI operation SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Data format Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 151: Spi Communications
The following diagram shows the frame format mode 0 for SPI communications. SPI mode is chip to chip communication. We do not supply a SPI communication option on the device development evaluation boards. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 152: Full Duplex Operation
SPI slave to start receiving another valid frame. The following figure illustrates the SPI interface while valid data is being sent in both directions. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 153: Low Power Operation
By default, Digi configures DIO8 (SLEEP_REQUEST) as a peripheral and during pin sleep it wakes the device and puts it to sleep. This applies to both the UART and SPI serial interfaces.
Page 154: Force Uart Operation
The XBee Smart Modem sends 0xFF when there is no data to send to the host. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 155: File System
File system For detailed information about using MicroPython on the XBee Smart Modem refer to the Digi MicroPython Programming Guide. Overview of the file system XCTU interface Encrypt files Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 156: Overview Of The File System
SHA256 hash of file contents available from ATFS HASH command (to compare with a local copy of a file). Encrypted on the SPI flash. MicroPython can execute code in secure files. Sockets can use secure files when creating TLS connections. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 157: Xctu Interface
SHA256 hash of the file contents. In this way you can validate that the correct file has been placed on the XBee Smart Modem. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 158: Sms Behaviors
The device converts incoming SMS messages to ASCII. Characters that cannot be represented in ASCII are replaced with a space (' ', or 0x20 in hex). This includes emoji and other special characters. Also referred to as the GSM 7-bit alphabet. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 159: Socket Behavior
Transparent mode behavior for outgoing TCP and TLS connections Transparent mode behavior for outgoing UDP data Transparent mode behavior for incoming TCP connections Transparent mode behavior for incoming UDP connections Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 160: Supported Sockets
TX request with the CLOSE flag set. 1 UDP socket is always reserved for DNS, so subtract 1 socket from the values above. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 161: Enable Incoming Tcp Connections
TCP and port. The following device supports incoming TCP connections: Part number: XB3-C-A1-UT-xxx (Digi XBee 3 Cellular AT&T LTE Cat 1) The XBee Smart Modem only supports incoming TCP and UDP connections as configured in IP (IP Protocol), TLS is not supported.
Page 162: Api Mode Behavior For Outgoing Udp Data
No data has been sent or received for longer than the socket timeout set by TS (IP Server Connection Timeout). A Transmit (TX) Request frame is sent with the CLOSE flag set. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 163: Api Mode Behavior For Incoming Udp Data
Smart Modem's serial port. Any data sent to the XBee Smart Modem's serial port is sent over the connection. If the connection is disconnected, it discards pending data. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 164: Transparent Mode Behavior For Incoming Udp Connections
DL (Destination Address) DE (Destination port) settings. If the DL and DE settings are unspecified or invalid, the XBee Smart Modem discards data sent to the serial port. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 165: Extended Socket Frames
Paste the provided frame content directly into the Add API frame to list window in XCTU to follow along manually. Extended Socket example: Single HTTP Connection Extended Socket example: UDP Extended Socket example: TCP Listener Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 166: 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 167: Receive A Socket Create Response
The request to connect is immediately acknowledged with a response. However, it is not permitted to proceed transmitting data until the next stage, after a Socket Status frame has been received indicating success. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 168: Receive A Socket Status
Field Value 0x44 (Socket Status) Frame type Frame ID 0x01 Socket ID 0x00 Transmit Options 0x00 GET /random/trivia HTTP/1.1 Data Host: numbersapi.com Connection: close Socket Send frame data: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 169: Receive Tx Status
X-Numbers-API-Number: 270 X-Numbers-API-Type: trivia Pragma: no-cache Cache-Control: no-cache Expires: 0 270 is the average number of days in human pregnancy. Receive Data received from XBee containing web service response: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 170: Receive Socket Status Indicating Closed Connection
Send a Socket Create frame Field Value 0x40 (Socket Create) Frame type Frame ID 0x01 Protocol 0x00 (UDP) UDP Socket Create frame data: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 171: Receive A Socket Create Response
The XBee generates a response indicating the status of the request to bind the requested port. Field Value 0xC6 (Socket Bind/Listen Response) Frame type Frame ID 0x01 Socket ID 0x00 Status 0x00 (Success) Socket Bind/Listen Response received from XBee: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 172: Send To Digi Echo Server
Extended Socket frames Extended Socket example: UDP 7E 00 04 C6 01 00 00 38 Send to Digi echo server Digi hosts a server at 52.43.121.77 port 10001 which echos all UDP traffic sent to it. Field Value 0x45 (Socket SendTo)
Page 173: 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 174: Close The Socket
0xC3 (Socket CloseResponse) Frame type Frame ID 0x01 Socket ID 0x00 Status 0x00 (Success) Socket Close Response received from XBee: 7E 00 04 C3 01 00 00 3B Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 175: Extended Socket Example: Tcp Listener
The Socket Bind/Listen Frame takes the socket ID from the socket create response and a source port that the socket will then listen on. In this example port 10001 is used. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 176: Receive A Socket Bind/Listen Response
It contains the listener's socket ID and the new Client Socket ID along with the connection's remote address information. Field Value 0xCC (Socket New IPv4 Client) Frame type Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 177: Receiving Data From The New Socket
Value 0xCF (Socket Status) Frame type Socket ID 0x01 Status 0x07 (Connection lost) Socket Status received from XBee indicating connection lost: 7E 00 03 CF 01 07 28 Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 178 When a Socket Status indicating a connection close is received, the socket ID will have been de- allocated by the XBee and no further operations are possible or necessary using that ID. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 179: Transport Layer Security (Tls)
Transparent mode and TLS API mode and TLS Key formats Certificate limitations Cipher suites Server Name Indication (SNI) Secure the connection between an XBee and Remote Manager with server authentication Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 180: Specifying Tls Keys And Certificates
2. Server authentication: Only ca_cert is provided. Only the servers identity is checked 3. Mutual authentication: All items are provided and both sides are assured of the identity of their peer It is not possible to only have client authentication. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 181: 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 182: Server Name Indication (Sni)
1. Verify the following settings: Setting Value Bit 0 (mask 0x1) must be set. This enables the use of Digi Remote Manager within the firmware. Bit 1 (mask 0x2) must be set. When this value is set the Remote Manager TCP connection will be secured with TLS.
Page 183 6 to verify that the server was correctly authenticated. 0: Connected without TLS 5: Connected with TLS but without authentication 6: Connected with TLS and with authentication Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 184 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 Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 185: 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 186: Sd (Shutdown)
Note Once you issue a WR command, do not send any additional characters to the device until after you receive the OK response. Parameter range Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 187: Cellular Commands
Reads the IMSI (International Mobile Subscriber Identity) from the SIM inserted into the module. Parameter range Default MN (Operator) Reads the network operator on which the device is registered. Parameter range Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 188: Mv (Modem Firmware Version)
Reads the current network-provided local time of the XBee device, as reported by the cellular tower. If the time is not known, the response is empty. This value is synchronized with the network approximately once per hour. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 189: An (Access Point Name)
When set, the cellular component of the XBee Smart Modem is fully turned off and no access to the cellular network is performed or possible. Parameter range 0 - 1 0 = Normal operation Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 190: Dv (Secondary Antenna Function Switch)
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 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 191: Sw (Reference Signal Received Power)
A value of a single space character (ASCII 0x20) acts as an empty value. Default 0x20: A single ASCII space that indicates there is no PUK. CU (Cellular user name) Specifies the user name used when authenticating to the cellular network. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 192: Cw (Cellular Password)
1 to 30 ASCII characters A value of a single space character (ASCII 0x20) acts as an empty value. Default 0x20: A single ASCII space that indicates there is no cellular password. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 193: Network Commands
Specifies the TLS certificate(s) to use in Transparent mode (when IP (IP Protocol) = 4) or API mode (Transmit (TX) Request: IPv4 - 0x20 Tx Request with TLS Profile - 0x23 with profile set to 0). Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 194: Tls Profile 1)
If you change the TM value while in API Mode, the value only applies to subsequently opened sockets. TM does not apply to explicit sockets. Parameter range 0 - 0xFFFF [x 100 ms] Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 195: Ts (Ip Server Connection Timeout)
Remote Manager succeeds or if the device is reset. Bits 1 - 7 Reserved Range Bitfield Description Enable Remote Manager support Reserved for future use Default 1 (Bit 0 enabled) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 196: Addressing Commands
011 for the United States. Range 5 - 20 ASCII digits including an optional + prefix Note In device firmware versions ending in *10 or earlier, the range is 7-20 ASCII digits. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 197: N1 (Dns Address)
In API mode, the address is represented as the binary four byte big-endian numeric value representing the IPv4 address. In Transparent or Command mode, the address is represented as a dotted-quad string notation. Parameter range Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 198: Destination Port)
When you issue LA in API mode, the IP address is formatted in binary four byte big-endian numeric value. In all other cases (for example, Command mode) the format is dotted decimal notation. Range Valid FQDN Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 199: Serial Interfacing Commands
NB (Parity) Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x02 Parameter Description 0x00 No parity 0x01 Even parity 0x02 Odd parity Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 200: Sb (Stop Bits)
0 - 0xFF Default FT (Flow Control Threshold) Set or display the flow control threshold. The device de-asserts CTS when FT bytes are in the UART receive buffer. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 201: Ap (Api Enable)
5. You must configure the cellular modem to use the same baud rate (AT+IPR) prior to changing this setting. Parameter range Parameter Description 1200 b/s 2400 b/s 4800 b/s Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 202 9600 b/s 19200 b/s 38400 b/s 57600 b/s 115200 b/s 230400 b/s 460800 b/s 921600 b/s Default uBlox based modules: 0x9 (460800 baud) Telit based modules: 0x7 (115200 baud) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 203: I/O Settings Commands
Sets or displays the DIO1/AD1 configuration (pin 19). Parameter range 0 - 6 Parameter Description Disabled SPI_ATTN Digital input Digital output, low Digital output, high I2C SCL Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 204: D2 (Dio2/Ad2)
Digital input Digital output, default low Digital output, default high Default D4 (DIO4) Sets or displays the DIO4 configuration (pin 11). Parameter range 0, 1, 3 - 5 Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 205: D5 (Dio5/Associated_Indicator)
Digital output, default high Default D6 (DIO6/RTS) Sets or displays the DIO6/RTS configuration (pin 16). Parameter range 0, 1, 3 - 5 Parameter Description Disabled RTS flow control Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 206: D7 (Dio7/Cts)
Sets or displays the DIO8/DTR/SLP_RQ configuration (pin 9). Parameter range 0, 1, 3 - 5 Parameter Description Disabled SLEEP_REQUEST input Digital input Digital output, default low Digital output, default high Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 207: D9 (Dio9/On_Sleep)
Parameter Description Disabled RSSI PWM0 output PWM0 output Digital input Digital output, low Digital output, high Default P1 (DIO11/PWM1 Configuration) Sets or displays the DIO11 configuration (pin 7). Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 208: P2 (Dio12 Configuration)
0, 1, 3 - 5 Parameter Description Disabled SPI_MISO Digital input Digital output, default low Digital output, default high Default P3 (DIO13/DOUT) Sets or displays the DIO13/DOUT configuration (pin 17). Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 209: P4 (Dio14/Din)
Internal pull-up/down resistors are not available for digital output pins, analog input pins, or for disabled pins. Use the PD command to specify whether the resistor is pull-up or pull-down. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 210: M0 (Pwm0 Duty Cycle)
The PWM period is 42.62 µs and there are 0x03FF (1023 decimal) steps within this period. When M0 = 0 (0% PWM), 0x01FF (50% PWM), 0x03FF (100% PWM), and so forth. Parameter range 0 - 0x3FF Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 211: M1 Command
M1 command Sets the duty cycle of PWM1 for P1 = 2, where a value of 0x200 is a 50% duty cycle. Parameter range 0 - 0x3FF Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 212: I/O Sampling Commands
Each field is a binary number of the size listed in the following table. Multi-byte fields are in big-endian byte order. Field Size Number of samples 1 byte Digital channel mask 2 bytes Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 213 AT commands I/O sampling commands Field Size Analog chanel mask 1 byte Samples 2 bytes each Parameter range Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 214: Sleep Commands
0x7530 (5 minutes) ST (Wake Time) Sets or displays the time to spend awake in cyclic sleep modes. Parameter range 0x1 - 0x36EE80 (x 1 ms) Default 0xEA60 (60 seconds) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 215: Command Mode Options
Set the required period of silence before and after the command sequence characters of the Command mode sequence (GT + CC + GT). The period of silence prevents inadvertently entering Command mode. Parameter range 0x2 - 0x6D3 (x 1 ms) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 216 AT commands Command mode options Default 0x3E8 (one second) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 217: Micropython Commands
PYE (Erase Bundled Code) PYE interrupts any running code, erases any bundled code and then does a soft-reboot on the MicroPython subsystem. PYV (Version Report) Report the MicroPython version. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 218 Sends KeyboardInterrupt to MicroPython. This is useful if there is a runaway MicroPython program and you have filled the stdin buffer. You can enter Command mode (+++) and send ATPY^ to interrupt the program. Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 219: Firmware Version/Information Commands
Parameter range Default Set in the firmware CK (Configuration CRC) Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. Parameter range 0 - 0xFFFFFFFF Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 220: Ai (Association Indication)
Last update succeeded. Update file transfer failed. Update image rejected by cellular component. 0x10 A problem processing the update request occurred. 0x11 Update was blocked by XBee sleep. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 221: 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 ATFOSmyftp.server.com Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 222 AT commands Firmware version/information commands Reading a parameter ATFOS myftp.server.com Initiating FTO OTA ATFOI Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 223: Diagnostic Interface Commands
The following table provides the parameter's meaning when IP = 0 for UDP connections. Parameter Description 0x00 The socket is open. 0x01 Tried to send but could not. 0x02 Invalid parameters (bad IP/host). Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 224 No network registration. 0x23 No internet connection. 0x24 No server - timed out on connection. 0x25 Unknown server - DNS lookup failed. 0x26 Connection refused. 0x27 Connection lost. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 225: As (Active Scan For Network Environment Data)
CID, and Signal. Each line describes a particular cell and only those values determined during a single scan are reported. Example atas S MCC:311 MNC:480 Area:48707 CID:48825632 Signal:-88 CID:48825612 Signal:-95 CID:48825603 Signal:-68 CID:48825601 Signal:-71 Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 226 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 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 227: Execution Commands
CAUTION! This command is for advanced users, and you should only use it if the cellular component becomes completely stuck while in Bypass mode. Normal users should never need to run this command. See the FR (Force Reset) command instead. Range Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 228: File System Commands
Directory names end with a forward slash (/) to differentiate them from files. Secure files end with a hash mark (#) and you cannot download them. <DIR> ./ <DIR> ../ <DIR> cert/ Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 229: Atfs Put Filename
Report on the size of the filesystem, showing bytes in use, available, marked bad and total. The report ends with a blank line, as with most multi-line AT command output. Example output: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 230: Atfs Format Confirm
The XBee Smart Modem responds with Formatting..., adds a period every second until the format is complete and ends the response with a carriage return. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 231: Ble Commands
The SRP (Secure Remote Password) Salt is a 32-bit number used to create an encrypted password for the XBee device. The $S command is used in conjunction with the $V, $W, $X, and $Y verifiers. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 232: V, $W, $X, $Y (Srp Password Verifier)
The salt is configured in the $S command. In the $V, $W, $X, and $Y verifiers, you specify the 128-byte verifier value, where each command represents 32 bytes of the total 128-byte verifier valule. Parameter range 1 - 32 bytes (1-64 hexadecimal characters in command mode) Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 233: Remote Manager Commands
Remote Manager connection to have failed after 3 missed keepalives. This command works with the K2 command to limit data usage. See Configure Remote Manager keepalive interval. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 234: K2 (Remote Manager Device Send Keepalive)
Parameter range 1 to 0xFFFF Value Description 0x3c One hour. Default 0x3c Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 235: Hm (Health Metrics)
Signal Strength. This is the same value as reported by the DB command in dbM and will be reported to the "metrics/signal_strength" Data Stream in Remote Manager for the devices. Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 236: System Commands
KP (Device Description) Sets or displays a user-defined description for the XBee displayed in Remote Manager. Range Up to 20 ASCII characters Default One ASCII space character (0x20) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 237: Socket Commands
The list is separated by carriage returns (<CR>) and terminated with an additional carriage return. In both API and command mode the payload/output will have the following format: ID<CR> STATE<CR> PROTOCOL<CR> LOCAL_PORT<CR> REMOTE_PORT<CR> REMOTE_ADDRESS<CR> <CR> Field Description The socket ID. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 238 The remote port of the socket. REMOTE_ADDRESS The remote IPv4 address for the given socket. This is 0.0.0.0 for an unconnected socket. Parameter range 0x00 - 0xFE Default Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 239: 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 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 240: Api Mode Overview
API operation (AP parameter = 1) This is the recommended API mode for most applications. The following table shows the data frame structure when you enable this mode: Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 241: Api Operation With Escaped Characters (Ap Parameter = 2)
To escape an interfering data byte, insert 0x7D and follow it with the byte to be escaped (XORed with 0x20). The following data bytes need to be escaped: 0x7E: start delimiter 0x7D: escape character Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 242 Data field organizes the information. Data contains the data itself. This information and its order depend on the what type of frame that the Frame type field defines. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 243 FF. 01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F + B8 = 2FF Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 244: Api Frames
Socket Bind/Listen - 0x46 Socket Listen Response - 0xC6 Socket New IPv4 Client - 0xCC Socket Receive - 0xCD Socket Receive From: IPv4 - 0xCE Socket Status - 0xCF Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 245: At Command - 0X08
Byte Command name: two ASCII characters that identify the AT command. command Parameter Byte If present, indicates the requested parameter value to set the given value register. If no characters are present, it queries the register. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 246: At Command: Queue Parameter Value - 0X09
Byte Command name: two ASCII characters that identify the AT command. command Parameter Byte If present, indicates the requested parameter value to set the given value register. If no characters are present, it queries the register. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 247: Transmit (Tx) Sms - 0X1F
(0x0) byte. Use numbers and the + symbol only, no other symbols or letters. Payload Variable Data to send as the body of the SMS message. (160 characters maximum) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 248: Transmit (Tx) Request: Ipv4 - 0X20
0 - Leave the socket open. Closed by timeout, see TM (IP Client Connection Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 249 Transmit (TX) Request: IPv4 - 0x20 Field Field name value Data type Description Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 250: Tx Request With Tls Profile - 0X23
0 - Leave the socket open. Closed by timeout, see TM (IP Client Connection Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 251 Tx Request with TLS Profile - 0x23 Field Field name value Data type Description Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 252: At Command Response - 0X88
1 = ERROR 2 = Invalid command 3 = Invalid parameter Parameter Byte Register data in binary format. If the register was set, then this field is value not returned. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 253: Transmit (Tx) Status - 0X89
0x7A Invalid host address 0x7B Invalid data mode Invalid interface. See User Data Relay - 0x2D. 0x7C Interface not accepting frames. See User Data Relay - 0x2D. 0x7D Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 254 No server 0x83 Socket closed 0x84 Unknown server 0x85 Unknown error 0x86 Invalid TLS configuration (missing file, and so forth) 0x87 Socket not connected 0x88 Socket not bound Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 255: Modem Status - 0X8A
The BLE Connect and BLE Disconnect events are reported over the UART/SPI interface in API mode when a valid Bluetooth connection has been made and API mode has been unlocked, and also when an unlocked connection disconnects. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 256: Receive (Rx) Packet: Sms - 0X9F
0x9F Byte Type Phone 20 byte String representation of the phone number, padded out with number string null bytes (0x0). Payload Variable Body of the received SMS message. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 257: Receive (Rx) Packet: Ipv4 - 0Xb0
MSB 12 0 = UDP Protocol 1 = TCP 4 = SSL over TCP Status Reserved Payload Data received from the source. The maximum size is 1500 bytes. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 258: User Data Relay - 0X2D
BLE connection. Use a cellphone to send the frame with UART interface as a target. Data contained within the frame is sent out the UART contained within an Output Frame. The external processor then receives and acts on the frame. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 259 An external processor outputs the Frame over the UART with the Micropython interface as a target. Micropython operates over the data and publishes the data to mqtt topic. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 260: User Data Relay Output - 0Xad
Data type Description Frame type 0xAD Byte Byte 0 = Serial port (SPI, or UART when Source interface in API mode) 1 = BLE 2 = MicroPython Data Variable Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 261: Ble Unlock Api - 0X2C
The following table provides the contents of the frame. For details on frame structure, see API frame format. Frame data fields Offset Description Frame type 0x2C = Request 0xAC = Response Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 262 Frame data field Offset in frame Length salt 4 bytes 128 bytes Phase 3 (Client presents M1) Frame data field Offset in frame Length Hash algorithm digest length (32 bytes for SHA256) Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 263: Example Sequence To Perform At Command Xbee Api Frames Over Ble
When successful, the response arrives in one or more indications. If your stack does not do it for you, remember to acknowledge each indication as it is received. Note that you are Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 264 Decrypt the stream of content provided through the indications, using the stream cipher as described in the unlock procedure. See BLE Unlock API - 0x2C. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 265: Ble Unlock Response - 0Xac
Bluetooth interface and unlock the processing of AT command frames. This frame is used in conjunction with the Response (0xAC) frame. For details, see BLE Unlock API - 0x2C. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 266: Socket Create - 0X40
Reference identifier used to match status responses. A response is required and will be sent regardless of the frame ID. Protocol Byte 0 = UDP 1 = TCP 4 = SSL over TCP Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 267: Socket Create Response - 0Xc0
Internal error Resource error: retry the operation later 0x32 Socket limits in API mode. Invalid protocol 0x7B 0x7E A modem update is in process. Try again after its completion. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 268: Socket Option Request - 0X41
Option Name Data Type Default Value Description 0x00 0x00 Determines the TLS TLS Profile Byte profile to be used: $0 - $2. This is valid only for TLS sockets. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 269: Socket Option Response - 0Xc1
0x02: Failed to retrieve option value 0x20: Bad socket ID Option Data Variable Current effective value of the option. This field is only present if the corresponding request was a query (empty value). Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 270: Socket Connect - 0X42
1: Indicates the destination address field is a string containing either a dotted quad value or a domain name to be resolved. Destination Variable address Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 271: Socket Connect Response - 0Xc2
Successfully started the connection process 0x01 Invalid destination address type 0x02 Invalid parameter: address or port 0x03 Connection already in progress 0x04 Already connected 0x05 Unknown error 0x20 Invalid socket ID Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 272: Socket Close - 0X43
Socket ID Byte The following options can be used: ID of the socket to be closed. 0xFF: Close all Extended API sockets that are currently open. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 273: Socket Close Response - 0Xc3
A reference identifier used to match status responses. Socket ID Byte ID of the socket that has been closed. 0x00 = Success Status Byte 0x20 = Bad socket ID Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 274: Socket Send (Transmit) - 0X44
Socket ID Byte ID of the socket to send on. Reserved Transmit options Byte bit-field Payload Variable Data to be transferred to the destination, up to 1500 bytes. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 275: Socket Sendto (Transmit Explicit Data): Ipv4 - 0X45
Destination address 32-bit big endian Destination port 16-bit big endian Transmit options Byte bit-field Reserved Payload Variable Data to be transferred to the destination, up to 1500 bytes. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 276: Socket Bind/Listen - 0X46
If set to 0, the device does not send a response. Socket ID Byte The socket ID to listen on. Source port 16-bit big endian The port to listen on. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 277: Socket Listen Response - 0Xc6
Status code. See table below. Status Byte The following table shows the status codes. Code Description 0x00 Success 0x01 Invalid port 0x02 Error 0x03 Already bound or listening 0x20 Invalid socket ID Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 278: Socket New Ipv4 Client - 0Xcc
The socket ID of the listener socket. Client Socket ID Byte The socket ID of the new connection. Remote address 32-bit big endian Remote port 16-bit big endian Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 279: Socket Receive - 0Xcd
ID of the socket that the data has been received on. Reserved Status Byte bit-field Payload Variable Data received from the destination. It may be up to 1500 bytes. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 280: Socket Receive From: Ipv4 - 0Xce
Source address 32-bit big endian Source port 16-bit big endian Status Byte bit-field Reserved Payload Variable Data to be transferred to the destination, up to 1500 bytes. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 281: Socket Status - 0Xcf
0x04 = Timed out 0x05 = Internal error 0x06 = Host unreachable 0x07 = Connection lost 0x08 = Unknown error 0x09 = Unknown server 0x0A = Resource error Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 282: Troubleshooting
Unresponsive cellular component in Bypass mode Not on expected network after APN change Syntax error at line 1 Error Failed to send SMS Baud rate in Bypass mode Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 283: Cannot Find The Serial Port For The Device
4. Remove the development board from the USB port and view which port name no longer appears in the Discover radio devices list of ports. The port name that no longer appears is the correct port for the development board. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 284: Other Possible Issues
5. Right-click the USB controller and select Properties; a dialog displays. 6. Select the Advanced tab. 7. Check Load VCP. 8. Click OK. 9. Unplug the board and plug it back in. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 285: Correct A Macos Java Error
2. Click Download to get the file javaforosx.dmg. 3. Double-click on the downloaded javaforosx.dmg. 4. In the dialog, double-click the JavaForOSX.pkg and follow the instructions to install Java. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 286: Unresponsive Cellular Component In Bypass Mode
XBee Smart Modem software. If AI is 0x2F, Bypass mode should work. If not, look at the status codes in AI (Association Indication) for guidance. 2. You can send the !R (Modem Reset) command to reset only the cellular component. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 287: Not On Expected Network After Apn Change
AT+IPR setting you will need to match it with the IB setting to maintain communication. Note Digi does not recommend using bypass mode. You should use USB Direct mode instead. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 288: Regulatory Information
Regulatory information Modification statement Interference statement FCC Class B digital device notice RF exposure FCC notices FCC-approved antennas Labeling requirements for the host device Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 289: Modification Statement
Modification statement Modification statement Digi International has not approved any changes or modifications to this device by the user. Any changes or modifications could void the user’s authority to operate the equipment. Digi International n’approuve aucune modification apportée à l’appareil par l’utilisateur, quelle qu’en soit la nature.
Page 290: Rf Exposure
If the antenna is mounted at least 25 cm from nearby persons, the application is considered a mobile application. The antennas below have been approved for use with this module. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas.
Page 291: Cellular Antennas
Certain approved antennas require attenuation for operation. For the XBee Smart Modem, see Cellular antennas. Host product user guides should include the antenna table if end customers are permitted to select antennas. 2.4 Limited module procedures Not applicable. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...
Page 292: Labeling Requirements For The Host Device
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 293 Contains FCC ID: RI7XE866A1NA Contains IC: 5131A-XE866A1NA This Class B digital apparatus complies with Canadian ICES-003. Cet appareil numérique de classe B est conforme à la norme canadienne ICES-003. Digi XBee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide...

This manual is also suitable for:

Xbee cellular lte cat 1

Digi XBee 3 User Manual

Digi Xbee® 3 Cellular LTE Cat 1 AT&T Smart Modem User Guide

Get Started with the Xbee Smart Modem

Xbee Connection Examples

Get Started with Micropython

Get Started with BLE

Get Started with Digi Remote Manager

Examples: IOT Protocols with Transparent Mode

Updatethefirmware

Technical Specifications

Hardware

Antenna Recommendations

Design Recommendations

Cellular Connection Process

Modes

Sleep Modes

Power Saving Features and Design Recommendations

Serial Communication

SPI Operation

File System

SMS Behaviors

Socket Behavior

Extended Socket Frames

Transport Layer Security (TLS)

Atcommands

Quick Links

Troubleshooting

Need help?

Questions and answers

Related Manuals for Digi XBee 3

Summary of Contents for Digi XBee 3