Xtend 900 mhz wireless modem
for use with veeder-root emr3 datalink (13 pages)
Summary of Contents for Digi XBee3 XB3M1
Page 1
Digi XBee3® Cellular LTE-M/NB-IoT Smart Modem User Guide...
Page 2
Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
Page 3
To provide feedback on this document, email your comments to techcomm@digi.com Include the document title and part number (Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide, 90002258 I) in the subject line of your email. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Contents Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide Applicable firmware and hardware SIM cards NB-IoT network Get started with the XBee Smart Modem Development Kit Identify the kit contents Acquire a SIM card US customers European customers Connect the hardware...
Page 5
Example: Read settings and state using Remote Manager Example: Configure a device from Remote Manager using XML Example: Update XBee firmware using Remote Manager Example: Update MicroPython from Remote Manager using XML Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 6
Custom configuration: Create a new factory default Set a custom configuration Clear all custom configurations on a device Clean shutdown SD (Shutdown) command Sleep feature Airplane mode Cellular connection process Connecting Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 7
Power saving features Airplane mode Power Saving Mode (PSM) PSM behavior Deep Sleep mode Serial communication Serial interface Serial data UART data flow Serial buffers CTS flow control RTS flow control Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 8
Server Name Indication (SNI) 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 9
BD (Baud Rate) NB (Parity) SB (Stop Bits) RO (Packetization Timeout) TD (Text Delimiter) FT (Flow Control Threshold) AP (API Enable) I/O settings commands D0 (DIO0/AD0) D1 (DIO1/AD1) D2 (DIO2/AD2) D3 (DIO3/AD3) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 10
Execution commands NR (Network Reset) !R (Modem Reset) File system commands Error responses ATFS (File System) ATFS PWD ATFS CD directory ATFS MD directory ATFS LS [directory] ATFS PUT filename ATFS XPUT filename ATFS HASH filename Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 11
User Data Relay - 0x2D Example use cases User Data Relay Output - 0xAD BLE Unlock API - 0x2C Example sequence to perform AT Command XBee API frames over BLE BLE Unlock Response - 0xAC Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 12
Socket leaks Condition Solution Regulatory information United States (FCC) OEM labeling requirements FCC notices FCC-approved antennas RF exposure FCC publication 996369 related information Innovation, Science and Economic Development Canada (ISED) Labeling requirements Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 13
RF Exposure CE mark (Europe) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 14
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...
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.
2. Review introductory MicroPython examples. You can use MicroPython to enhance the intelligence of the XBee to enable you to do edge-computing by adding business logic in MicroPython, rather than using external components. Example: hello world Example: turn on an LED Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
One SIM card Note NB-IoT kits (Digi product number XK3-C-N1-UT-E) do not include a SIM card. Contact your NB-IoT mobile carrier provider to obtain a SIM card and service. Acquire a SIM card. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Get started with the XBee Smart Modem Development Kit Acquire a SIM card Acquire a SIM card NB-IoT kits (Digi product number XK3-C-N1-UT-E) do not include a SIM card. The sections below explain how to purchase an NB-IoT SIM card in the US and Europe. US customers In the US, Digi XBee3®...
SIM card into the XBee Smart Modem before attaching the XBee device to the board. Note NB-IoT kits (Digi product number XK3-C-N1-UT-E) do not include a SIM card. Contact your NB-IoT mobile carrier provider to obtain a SIM card and service. See Acquire a SIM card.
Page 20
6. 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. If you have trouble downloading the USB driver, see Other possible issues. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Get started with the XBee Smart Modem Development Kit XBIB-U-DEV reference XBIB-U-DEV reference This picture shows the XBee USB development board and the table that follows explains the callouts in the picture. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 22
DS2: DIO12, the LED illuminates when driven low. DS3: DIO11, the LED illuminates when driven low. DS4: DIO4, the LED illuminates when driven low. Connects the Digi XBee3® Cellular LTE-M/NB-IoT modem to the Through-hole XBee XBee USB development board. sockets 20-pin header Maps to standard through-hole XBee pins.
Get started with the XBee Smart Modem Development Kit XBIB-CU-TH reference 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 24
RESET Button Connects to the RESET pin on the XBee Connector to GND when pressed. Breakout This 40 pin connector can be used to connect to various XBee pins as Connector shown on the silkscreen on the bottom of the board. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 25
This is the socket for the XBee (TH form factor). XBee Test Allows easy access for probes for all 20 XBee TH pins. Pin 1 is shorted to Point Pins Pin 1 on the XBee and so on. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Note For a demo of how to use MicroPython to parse some of the GPS NMEA sentences from the UART, print them and report them to Digi Remote Manager, see Run the MicroPython GPS demo. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Class UART. Run the MicroPython GPS demo The Digi MicroPython github repository contains a GPS demo program that parses some of the GPS NMEA sentences from the UART, prints them and also reports them to Digi Remote Manager. Note If you are unfamiliar with MicroPython on XBee you should first run some of the tutorials earlier in this manual to familiarize yourself with the environment.
Cellular service Digi now offers Cellular Bundled Service plans. This service includes pre-configured cellular data options that are ideal for IoT applications, bundled together with Digi Remote Manager for customers who want to remotely monitor and manage their devices. Note The Digi Cellular Bundled Service plan is not offered for NB-IoT.
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.
Note LTE-M is configured by default. You can skip this section if you are using LTE-M. If you are using an NB-IoT kit, you must configure the device to use NB-IoT. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 32
6. To set the CP, in the CP field, select No Profile (1) and click the Write button 7. Reset the module with either the reset button or issue the command. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
If the carrier makes a change to the service, reset the module and wait 5-6 minutes. If the carrier does not make a change to the service, then contact Digi support. Check for cellular registration and connection In the following examples, proper cellular network registration and address assignment must occur successfully.
FTP server and the script attempts to apply the appropriate update files based on intelligence built into the script. The optional arguments should only rarely need to be changed and generally only if the Digi FTP server is not accessible on a private APN, or by direction of Digi Technical Support.
Page 35
3. Navigate to the directory containing the script. 4. Run pip install -r requirements.txt in the directory containing the script. 5. Verify that you are in the same directory as the script. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 36
How the script works. 8. When complete, a digi-update.log text file is created, which contains a copy of the log messages emitted to the terminal while the script was running. 9. A successful update appears as: 2019-06-27 16:06:28,479 update.py: INFO: Reading cellular component version string (ATMV)...
Internal Error), repeat for the next package number. If this was package number 3, stop and contact Digi Technical Support. 6. Download the relevant "stage 2" update file from Digi's FTP server, using HTTP. For example, http://ftp1.digi.com/support/ublox/2stg-upd-for-IP/stg2-pkg- 5.6A2.00_to_5.6A2.01.pkg. The file name is stg2-pkg-5.6A2.00_to_ 5.6A2.01.pkg.
Page 38
FTP server and the script attempts to apply the appropriate update files based on intelligence built into the script. The optional arguments should only rarely need to be changed and generally only if the Digi FTP server is not accessible on a private APN, or by direction of Digi Technical Support.
Note Disable hardware flow control when entering and communicating with the XBee3 cellular bootloader. All serial communications with the module use 8 data bits, no parity bit, and 1 stop bit. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 40
Get started with the XBee Smart Modem Development Kit XBee bootloader You can update firmware on the XBee Smart Modem serially. This is done by invoking the bootloader and transferring the firmware image using XMODEM. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Connect to the ELIZA server Connect to the Daytime server Perform a (GET) HTTP request Get started with CoAP Connect to a TCP/IP address Get started with MQTT Debugging Software libraries Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
8. To enter the destination IP port number, in the DE field, type 2329 and click the Write button. Note XCTU does not follow the standard hexadecimal numbering convention. The leading 0x is not needed in XCTU. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 43
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 45
XBee connection examples Connect to the ELIZA server Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 47
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
2E 6F 72 67 0D 0A 0D 0A Note The HTTP protocol requires an empty line (a line with nothing preceding the CRLF) to terminate the request. 15. Click Add packet. 16. Click the Open button Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 49
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
The following diagram shows the message format for the CoAP protocol; see ISSN: 2070-1721 details: This is an example GET request: 44 01 C4 09 74 65 73 74 B7 65 78 61 6D 70 6C 65 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Read to get an update on the AI value. Example: manually perform a CoAP request Follow the steps in Configure the device prior to this example. This example performs the CoAP GET request: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 53
In the following figure, the payload contains the server response to the query. It shows the results for when you press Enter rather than Y. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Exit Command mode. After exiting Command mode, any UART data sent to the device is sent to the destination IP address and port number after the RO (Packetization Timeout) occurs. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
The following table is an example connect packet: Description Hex value CONNECT packet fixed header byte 1 Control packet type 0x10 byte 2 Remaining length 0x10 CONNECT packet variable header Protocol name Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 56
Clean Session flag, which indicates to the client and broker to discard any previous session and start a new one. Keep Alive How often the client pings the broker to keep the connection alive; in this example it is set to 60 seconds. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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.
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
# 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
4. You can make the proxy with a dual-threaded Python script, a simple version follows: import threading import serial import socket def setup(): """ This function sets up the variables needed, including the serial port, and it's speed/port settings, listening socket, and localhost adddress. """ Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 61
- 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 62
MQTT client to use the data connection provided by the device. Think of the proxy script as a translator between the MQTT client and the XBee Smart Modem. The following figure shows the basic operation. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
The XBee Python Library is a Python API that dramatically reduces the time to market of XBee projects developed in Python and facilitates the development of these types of applications, making it an easy process. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Use XCTU to enter the MicroPython environment Use the MicroPython Terminal in XCTU Example: hello world Example: turn on an LED Example: debug the secondary UART Exit MicroPython mode Other terminal programs Use picocom in Linux Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
. 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
1. Note the DS4 LED on the XBIB board. The following image highlights it in a red box. The LED is normally off. Other terminal programs if you do not use the MicroPython Terminal in XCTU. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
You have successfully controlled an LED on the board using basic I/O. Example: debug the secondary UART This sample code is handy for debugging the secondary UART. It simply relays data between the primary and secondary UARTs. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Tera Term, if you use Linux, follow the instructions for picocom. To download these programs: Tera Term for Windows; see https://ttssh2.osdn.jp/index.html.en. Picocom for Linux; see https://developer.ridgerun.com/wiki/index.php/Setting_up_Picocom_-_ Ubuntu and for the source code and in-depth information https://github.com/npat- efault/picocom. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Receive drop-down menu and select CR if it does not already show that value. c. Make sure the Local echo box is not checked. 9. Click OK. 10. Press Ctrl+B to get the MicroPython version banner and prompt. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
3. Check the directory again and you should see one additional device, which is the XBee Smart 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 71
Get started with MicroPython Use picocom in Linux Now you can type MicroPython commands at the >>> prompt. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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.
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.
Android 5.0 or higher iOS 11 or higher 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.
If the Bluetooth Unlock API Frame has not been executed, all other API frames will be silently ignored and not processed. API Response characteristic UUID: f9279ee9-2cd0-410c-81cc-adf11e4e5aea Permissions: Readable, Indicate Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 76
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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.
Guide, available via the Documentation tab in Remote Manager. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. Before you can manage an XBee with Remote Manager, you must create a Remote Manager account.
Update your security certificates Perform a data service device request Send an SMS message to your device Scheduled tasks can be created and performed through the following methods: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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.
You must upgrade your device to the latest firmware for this feature to be available. See Update the firmware from Remote Manager Update the firmware using web services in Remote Manager. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Configure Remote Manager features by scheduling tasks 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.
Remote Manager Update the firmware using web services in Remote Manager. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. To upgrade using a scheduled task perform the following steps: Step 1: 1.
Page 84
Remote Manager Update the firmware using web services in Remote Manager. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. Step 1: Upload the MicroPython files Log into Remote Manager.
7 to connect securely over TLS, or you can use 1 for no security, which is the legacy value. You can make the change using one of the following methods: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
10. Click Device Management > Operations to view information about the operation. See Operations in the Digi Remote Manager® User Guide for more information about this page. Manage data in Remote Manager You can view and manage XBee data in Remote Manager. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Update the firmware using web services in Remote Manager. 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 90
XBee3 CAT 1 31011 Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. WARNING! The firmware version 1140F reorganizes the product's flash memory and upgrades the product to version 11410. You cannot downgrade to a version earlier than 11410 after installing 1140F/11410.
11410. You cannot downgrade to a version earlier than 11410 after installing 1140F/11410. Note Digi Remote Manager requires TCP and will not work with NB-IoT, unless the carrier supports TCP. 1. Download the updated firmware file for your device from Digi's support site.
Page 92
# Remote Manager device ID of the device being updated device_id = '00010000-00000000-03526130-70153378' # Remote Manager username and password username = "my_remote_manager_username" password = "my_remote_manager_password" url = 'https://remotemanager.digi.com/ws/sci' # Form update_firmware request Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 93
<device id="{}"/> </targets> <data>{}</data> </update_firmware> </sci_request> """.format(device_id, fw_data) # Post request r = requests.post(url, auth=(username, password), data=data) if (r.status_code != 200) or ("error" in r.content.decode('utf-8')): print("firmware update failed") else: print("firmware update success") Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Manage secure files in Remote Manager You can interact with files on the XBee device from Remote Manager, using either the SCI (Server command interface) or in the File Management view. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Remote Manager. Remote Manager reference Enable SM/UDP You can use the SM/UDP feature to leverage the very small data footprint of Remote Manager SM protocol over UDP. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 97
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 98
(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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Receive sensitivity, 2 Mb/s data rate -88 dBm Operating frequency band ISM 2.4 - 2.4835 GHz Cellular networking specifications The following table provides the networking and carrier specifications for the device. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Digi Trustfence™ Downlink/uplink speeds Up to 375 kb/s Duplex mode Half-duplex Power requirements The following table provides the power requirements for the device. Specification Value Supply voltage 3.3 to 4.3 V Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Active mode current Idle/connected, 20 mA 35 mA listening Power save mode 20 µA Not supported current Deep sleep current 10 µA 10 µA (USB direct mode must be disabled during sleep) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Electrical specifications The following table provides the electrical specifications for the XBee Smart Modem. Symbol Parameter Condition Typical Units VCCMAX Maximum limits of VCC line (VCC - 0.15 V) or 3.3 V, VDD_IO Internal supply voltage VCC or 3.3 V, whichever is whichever is lower for I/O lower...
Hardware Mechanical drawings Mechanical drawings The following figures show the mechanical drawings for the XBee Smart Modem. All dimensions are in inches. Pin signals The pin locations are: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
To ensure compatibility with future updates, make USB D+ and D- (pin 7 and pin 8) available in your design. 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
DI (Remote Manager Indicator) (Protocol/Connection Indication) for the cause of the error. Standard single blink 1 second Normal operation. The normal association LED signal alternates evenly between high and low as shown below: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 109
Where the low signal means LED off and the high signal means LED on. When CI is not 0 or 0xFF, the Associate LED has a different blink pattern that looks like this: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Often, small antennas are desirable, but may come at the cost of reduced range and efficiency. If you implement the Bluetooth interface, ensure that the Bluetooth and cellular antennas are at least 3 inches apart (6 inches recommended) to prevent cellular sensitivity from being degraded. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
3.2 V during operation. Minimum connection diagram In high EMI noise environments, we recommend adding a 10 nF ceramic capacitor very close to pin 5. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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.
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
1. The server closes the connection. 2. The TM timeout expires (see TM (IP Client Connection Timeout)). 3. The cellular network may also close the connection after a timeout set by the network operator. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
2. The cellular connection is shut down. 3. The cellular component is powered off. Note We recommend entering Airplane mode before resetting or rebooting the device to allow the cellular module to detach from the network. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Bypass operating mode. The default mode is Transparent operating mode. Use the AP (API Enable) command to select a different operating mode. The following flowchart illustrates how the modes relate to each other. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
When the device is in Command mode, it listens for user input and is able to receive AT commands on the UART. If CT time (default is 10 seconds) passes without any user input, the device drops out of Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Response to AT commands When using AT commands to set parameters the XBee Smart Modem responds with OK<cr> if successful and ERROR<cr> if not. For devices with a file system: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
REPL or code launched at startup. When code runs in MicroPython with AP set to a value other than 4, stdout goes to the bit bucket and there is no input to read on stdin. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
USB direct mode USB direct mode Note In order to use USB direct mode in Digi XBee development kits, you must use the XBIB-C-TH development board. Note You should use this mode if you want to connect using PPP through the cellular modem while using a host operating system, such as embedded Linux.
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Sleep modes About sleep modes Normal mode Pin sleep mode Cyclic sleep mode Cyclic sleep with pin wake up mode SPI mode and sleep pin functionality The sleep timer MicroPython sleep behavior Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
XBee Smart Modem, or keeps it awake. De-asserting SPI_SSEL by driving it high puts the device to sleep. If neither pin is configured as a peripheral, then the device stays awake, being unable to sleep when SM (Sleep Mode) is 1. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
(b'', (<address from connect()>, <port from connect()>) ) The underlying UDP socket resources have been released at this point. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Power saving features Airplane mode Power Saving Mode (PSM) PSM behavior Deep Sleep mode Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
GSMA for a description of what the PSM timers are and what functions they perform on the network. Deep Sleep mode In Deep Sleep mode the cellular component is shut off and the XBee processor is put to sleep. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 132
Power saving features Deep Sleep mode Note When the XBee Smart Modem enters deep sleep mode, any MicroPython code currently executing is suspended until the device comes out of sleep. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Serial communication Serial interface Serial data UART data flow Serial buffers CTS flow control RTS flow control Enable UART or SPI ports Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Devices that have a UART interface connect directly to the pins of the XBee Smart Modem as shown in the following figure. The figure shows system data flow in a UART-interfaced environment. Low- asserted signals have a horizontal line over the signal name. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
If you change the configuration so that only one port is configured, then that port is the only one enabled or used. If the parameters are written with only one port enabled, then the port that is not enabled is not used even temporarily after the next reset. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
If both ports are disabled on reset, the device uses the UART in spite of the wrong configuration so that at least one serial port is operational. For I C see the Class I2C: two-wire serial protocol section in the MicroPython Programming Guide details. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
SPI operation SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Data format Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
The following diagram shows the frame format mode 0 for SPI communications. SPI mode is chip to chip communication. We do not supply a SPI communication option on the device development evaluation boards. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
SPI slave to start receiving another valid frame. The following figure illustrates the SPI interface while valid data is being sent in both directions. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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.
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 SSL/TLS connections. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
API mode behavior for incoming UDP data Transparent mode behavior for outgoing TCP and SSL connections Transparent mode behavior for outgoing UDP data Transparent mode behavior for incoming TCP connections Transparent mode behavior for incoming UDP connections Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. 1 TCP socket is used for Remote Manager, so if you have Remote Manager enabled, subtract 1 socket from the values above. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
If the connection is disconnected at any time, send a Transmit TX Request frame to trigger a new connection attempt. To send data over this connection use the Transmit (TX) Request: IPv4 - 0x20. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
The XBee Smart Modem does not currently support the SSL protocol for incoming connections. Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
No data has been sent or received for longer than the socket timeout set by TM (IP Client Connection Timeout). You make and apply a change to the IP, DL, or DE. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Any data sent to the XBee Smart Modem's serial port is sent to the network destination specified by DL (Destination Address) DE (Destination port) settings. If the DL and DE settings are unspecified or invalid, the XBee Smart Modem discards data sent to the serial port. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Transparent mode and TLS API mode and TLS Key formats Certificate formats Certificate limitations Cipher suites Server Name Indication (SNI) Secure the connection between an XBee and Remote Manager with server authentication Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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://www.amazontrust.com/repository/. The intermediate "root CAs"...
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.
The XBee devices that have the x11 or later version of the firmware installed are by default able to secure the TLS connection to Digi Remote Manager. The default configuration provides confidentiality of the communication but is not able to authenticate the server without a certificate being provided.
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 156
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 157
I/O settings commands 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 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
(Write) command after issuing the RE command to save restored parameter values to non-volatile memory. Parameter range Default WR (Write) Writes parameter values to non-volatile memory so that parameter modifications persist through subsequent resets. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 159
AT commands Special commands 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Reads the network operator on which the device is registered. Parameter range Default MV (Modem Firmware Version) Read the firmware version string for cellular component communications. See the related (Firmware Version) command. Parameter range Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Changes to the value only take effect on boot so a reboot or power cycle is required for any changes to become active. Parameter range 0 - 3 Value Description Autodetect from inserted ICCID (SIM) [default] Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
1, the BN command will return an error. Changes to the value only take effect on boot so a reboot or power cycle is required for any changes to become active. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
This command applies only to XBee3 Cellular LTE-M/NB-IoT. Allows the XBee Cellular LTE-M/NB-IoT module to select the preferred network technology. A reboot or power cycle is required for any parameter changes to become active. Range 0 - 3 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 164
AT commands Cellular commands Parameter Description LTE-M with NB-IoT fallback. NB-IoT with LTE-M fallback. LTE-M only. NB-IoT only. Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Range Value Description 0x00 SSL v3 0x01 TLS v1.0 0x02 TLS v1.1 0x03 TLS v1.2 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 Parameter range From 1 through 127 ASCII characters. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Bit 2 - USB direct enable Set bit 2 to enable USB direct mode. After setting, use WR (Write) to write all values to flash and use FR (Force Reset) to reset the device. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
32-bit number. This is the default. The response is the current date and time in ISO 8601 format. For example, "2018-12-25T22:00:05". Note You can also send DT, which acts like DT=0. Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
International Dialing Prefix for your calling region, for example, 011 for the United States. Range 7 - 20 ASCII digits including an optional + prefix Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 Default 0.0.0.0 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
0x3 (9600 b/s) 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
To use a carriage return, set to 0xD. Set to zero to disable text delimiter checking. Parameter range 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Default D1 (DIO1/AD1) 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Sets or displays the DIO3/AD3 configuration (pin 17). Parameter range 0 - 5 Parameter Description Disabled SPI_SSEL Analog input Digital input Digital output, default low Digital output, default high Default D4 (DIO4) Parameter range Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
RTS flow control Digital input Digital output, default low Digital output, default high Default D7 (DIO7/CTS) Sets or displays the DIO7/CTS configuration (pin 12). Parameter range 0, 1, 3 - 5 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Digital output, default low Digital output, default high Default D9 (DIO9/ON_SLEEP) Sets or displays the DIO9/ON_SLEEP configuration (pin 13). Parameter range 0, 1, 3 - 5 Parameter Description Disabled ON/SLEEP output Digital input Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Fan enable. Output is low when the XBee Smart Modem is sleeping, turning an attached fan off when the cellular component is in a power saving mode, and also during Airplane Mode Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Digital input Digital output, default low Digital output, default high Default P3 (DIO13/DOUT) Sets or displays the DIO13/DOUT configuration (pin 17). Parameter range 0, 1 Parameter Description Disabled UART DOUT enabled Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
If you set a PR bit to 0, it specifies no internal pull-up/down resistor. The following table defines the bit-field map for both the PR and PD commands. I/O line Module pin DIO4 pin 11 DIO3/AD3 pin 17 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
The PWM period is 42.62 µs and there are 0x03FF (1023 decimal) steps within this period. When M0 = 0 (0% PWM), 0x01FF (50% PWM), 0x03FF (100% PWM), and so forth. Parameter range 0 - 0x3FF Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 184
AT commands I/O sampling commands Field Size Analog chanel mask 1 byte Samples 2 bytes each Parameter range Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
3GPP timer T3412. Note For NB-IoT, TCP support is dependent on the network. Contact your network provider for details. Parameter range 0 - 0x35683200 (* 1 s) Default 0x8ca00 (576000 s) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 188
AT commands Command mode options Default 0x3E8 (one second) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
A timestamp of 2000-01-01T00:00:00 indicates that the clock was not set during compilation. In API mode, PYC returns five 32-bit big-endian values: source size source hash bytecode size bytecode hash timestamp as seconds since 2000-01-01T00:00:00 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 190
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Connected to the Internet. 0x22 Registering to cellular network. 0x23 Connecting to the Internet. 0x24 The cellular component is missing, corrupt, or otherwise in error. The cellular component requires a new firmware image. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Read the device's hardware series number. Parameter range Default Set in the firmware CK (Configuration CRC) Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. Parameter range 0 - 0xFFFFFFFF Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 194
No server - timed out on connection. 0x25 Unknown server - DNS lookup failed. 0x26 Connection refused. 0x27 Connection lost. 0x28 Unknown. 0xFF No known status. Parameter range 0 - 0xFF (read-only) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
0 or no value in the service area of the module. When you run the command, the cell module waits until all other communication is idle and then performs the scan. Parameter range Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Reformats the file system, leaving it with a default directory structure. Pass the word confirm as the first parameter to confirm the format. 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
XBee device does not allow for 0 to be valid salt. If the value is 0, SRP is disabled and you will not be able to authenticate using Bluetooth. Parameter range 0 - FFFFFFFF Default Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Specify the Remote Manager Device Send Transmit Keepalive Interval value in seconds. The Remote Manager considers a connection to have failed after 3 missed keepalives. This command works with the K1 command to limit data usage. See Configure Remote Manager keepalive interval. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Defines the SSL/TLS Remote Manager certificate. Parameter range Default /flash/cert/digi-remote-mgr.pem RI (Remote Manager Service ID) Sets the Remote Manager service ID for the XBee. Configure SMS messaging in Remote Manager for more information. Range Default idgp Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
One ASCII space character (0x20) KC (Contact Information) Sets or displays user-defined contact information for the XBee displayed in Remote Manager. Range Up to 20 ASCII characters Default One ASCII space character (0x20). Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Frame data Checksum API operation (AP parameter = 1) This is the recommended API mode for most applications. The following table shows the data frame structure when you enable this mode: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 209
Frame type is the API frame type identifier. It determines the type of API frame and indicates how the 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 211
Receive (RX) Packet: SMS - 0x9F Receive (RX) Packet: IPv4 - 0xB0 User Data Relay - 0x2D User Data Relay Output - 0xAD BLE Unlock API - 0x2C BLE Unlock Response - 0xAC Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Byte Command name: two ASCII characters that identify the AT command. command Parameter Byte If present, indicates the requested parameter value to set the given value register. If no characters are present, it queries the register. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Byte Command name: two ASCII characters that identify the AT command. command Parameter Byte If present, indicates the requested parameter value to set the given value register. If no characters are present, it queries the register. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
(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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 network. Contact your network provider for details. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 216
Ignore this bit for UDP packets. All other bits are reserved and should be 0. Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. UDP is limited to 512 bytes. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
If there is no matching socket, the TX Status frame returns an error. TLS profile Byte Zero-indexed number that indicates the profile as specified by the corresponding $<num> command. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 218
Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Status 1 = ERROR 2 = Invalid command 3 = Invalid parameter Parameter Byte Register data in binary format. If the register was set, then this field is value not returned. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Invalid TCP port 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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 221
Transmit (TX) Status - 0x89 Code Description 0x80 Connection refused 0x81 Socket connection lost 0x82 No server 0x83 Socket closed 0x84 Unknown server 0x85 Unknown error 0x86 Invalid TLS configuration (missing file, and so forth) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Data type Description Frame 0x9F Byte Type Phone 20 byte String representation of the phone number, padded out with number string null bytes (0x0). Payload Variable Body of the received SMS message. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
16-bit big endian. LSB 11 MSB 12 0 = UDP Protocol 1 = TCP 4 = SSL over TCP Status Reserved Payload Data received from the source. The maximum size is 1500 bytes. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 226
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
The following table provides the contents of the frame. For details on frame structure, see API frame format. Field name Field value Data type Description Delimiter Length Frame type 0xAD Byte 1 Byte Source interface Data Variable Checksum 1 Byte Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Frame data fields Offset Description Frame type 0x2C = Request 0xAC = Response Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 229
Phase 2 (Server presents B and salt) Frame data field Offset in frame Length salt 4 bytes 128 bytes Phase 3 (Client presents M1) Frame data field Offset in frame Length Hash algorithm digest length (32 bytes for SHA256) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
3. Optional, but recommended, request a larger MTU for the GATT connection. 4. Turn on indications for the API Response characteristic. 5. Perform unlock procedure using unlock frames. See BLE Unlock API - 0x2C. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 231
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
The XBee Smart Modem uses the BLE Unlock API - 0x2C frame to authenticate a connection on the Bluetooth interface and unlock the processing of AT command frames. This frame is used in conjunction with the Response (0xAC) frame. For details, see BLE Unlock API - 0x2C. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 233
Packaged firmware updates You can perform packaged firmware updates. About packaged firmware updates FW Update - 0x2B FW Update Response - 0xAB Important notes Perform a cellular component firmware update Error recovery Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
But to downgrade from Release 3 or greater to Release 2 or less, you must downgrade the cellular component firmware before downgrading the module firmware. Otherwise, the older firmware would not be able to downgrade the cellular component firmware. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
This frame is read from the module and it provides the status for each 0x2B frame sent. Format The following table provides the contents of the frame. Frame data fields Offset Type Description uint8 Value from request payload. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Send the last block of the file with the next ID and with bit 1 set to indicate last frame. Wait for an ACK on the final case. The final ACK will not arrive until the update has been applied and verified, which can take up to 25 minutes. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
If the host sets bit 2 of the flags byte in FW Update - 0x2B, the update in progress is aborted. Recovery is then equivalent to the recovery for negative acknowledgments, described above. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Correct a macOS Java error Unresponsive cellular component in Bypass mode Syntax error at line 1 Error Failed to send SMS Network connection issues Brownout issue Hardware flow control in Bypass mode Socket leaks Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
1. Click More info to open a browser window. 2. Click Download to get the file javaforosx.dmg. 3. Double-click on the downloaded javaforosx.dmg. 4. In the dialog, double-click the JavaForOSX.pkg and follow the instructions to install Java. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Silicon Labs has corrected these issues in revision C of their SoC. We are printing the SoC revision on the XBee label to make it easy to distinguish. The revision letter is located on the bottom right corner Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
For Transparent and API modes the XBee Smart Modem returns specific status responses to describe that you need to perform a hard reset to recover the leaked sockets. These statuses are: Mode Response CI (Protocol/Connection Indication) reports 0x13 Socket leak Transparent mode Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
When attempting to make a connection to a server you receive errno.ENFILE MicroPython (7023) Solution To recover the leaked sockets and make them available again in all modes, you should perform a reset of the cellular component (hard or soft). Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Regulatory information United States (FCC) Innovation, Science and Economic Development Canada (ISED) CE mark (Europe) Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
FCC notices IMPORTANT: XBee3 RF Modules have been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091). Modifications not expressly approved by Digi could void the user's authority to operate the equipment.
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.
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.
énumérés ci-dessous et ayant un gain admissible maximal et l'impédance requise pour chaque type d'antenne. Les types d'antenne non inclus dans cette liste, ou dont le gain est supérieur au gain maximal indiqué, sont strictement interdits pour l'exploitation de l'émetteur. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 251
OEM labeling requirements The CE marking must be affixed to a visible location on the OEM product. CE labeling requirements The CE mark shall consist of the initials “CE” taking the following form: Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Page 252
The CE marking must have a height of at least 5mm except where this is not possible on account of the nature of the apparatus. The CE marking must be affixed visibly, legibly, and indelibly. Digi XBee3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide...
Need help?
Do you have a question about the XBee3 XB3M1 and is the answer not in the manual?
Questions and answers