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.
Contents Digi XBee3 Cellular LTE-M Global Smart Modem User Guide Applicable firmware and hardware SIM cards Getting started with the XBee Smart Modem Development Kit Identify the kit contents Connect the hardware XBIB-U-DEV reference Cellular service Configure the device using XCTU...
Page 4
Enter Bypass operating mode Leave Bypass operating mode Restore cellular settings to default in Bypass operating mode USB direct mode Configure the data pins Enable USB direct mode Command mode Enter Command mode Troubleshooting Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 5
Full duplex operation Low power operation Select the SPI port Force UART operation Data format File system Overview of the file system Directory structure Paths Secure files XCTU interface Encrypt files Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 7
PU (Requested Tracking Area Update Timer) Command mode options CC (Command Sequence Character) CT (Command Mode Timeout) CN (Exit Command mode) GT (Guard Times) MicroPython commands PS (Python Startup) PY (MicroPython Command) Firmware version/information commands Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 8
Receive (RX) Packet: IPv4 - 0xB0 Configure the XBee Smart Modem using Digi Remote Manager Create a Remote Manager account Get the XBee Smart Modem IMEI number Add a XBee Smart Modem to Remote Manager Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 9
Hardware flow control in Bypass mode Socket leaks Condition Solution Regulatory information United States (FCC) OEM labeling requirements FCC notices FCC-approved antennas RF exposure Innovation, Science and Economic Development Canada (ISED) Labeling requirements RF Exposure Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
The XBee Smart Modem provides OEMs with a simple way to integrate low-power cellular connectivity into their devices. The XBee Smart Modem contains a u-blox R410M-02B module that also supports NB-IoT. Digi has not released support for the NB-IoT feature. Contact your sales representative if you would like more information about our roadmap to support NB-IoT.
Digi XBee3 Cellular LTE-M Global Smart Modem User Guide Applicable firmware and hardware Airplane mode support Digi TrustFence secure boot Multi-network capability (Verizon, AT&T) Applicable firmware and hardware This manual supports the following firmware: 114xx It supports the following hardware:...
XBIB-U-DEV reference Cellular service Configure the device using XCTU Connect to the ELIZA server Connect to the Echo server Connect to the Daytime server Get started with MicroPython More examples Software libraries Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
One Bluetooth Low Energy (BLE) antenna (BLE support is forthcoming but not currently available) One USB cable One XBee Smart Modem Note The XBee Smart Modem comes attached to the board in ESD wrap. One SIM card Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
WARNING! Never insert or remove the SIM card while the device is powered! Note The SIM cards in XBee3 Cellular LTE-M Global Smart Modem kits do not support SMS. 3. Connect the antennas to the XBee Smart Modem by aligning the U.FL connectors carefully, then firmly pressing straight down to seat the connector.
Page 15
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 XBee3 Cellular LTE-M Global Smart Modem User Guide...
Getting 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 Global Smart Modem User Guide...
Digi now offers Cellular Bundled Service plans. This service includes preconfigured cellular data options that are ideal for IoT applications, bundled together with Digi Remote Manager for customers Powering the board with J2 and J5 without R31 removed can cause shorts if the USB or barrel plug power are connected.
XBee Configuration and Test Utility (XCTU) is a multi-platform program that enables users to interact with Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices.
If you have already updated the firmware in a previous step, this process is not necessary. 1. Click the Configuration working modes button 2. Select a local or remote XBee module from the Radio Modules list. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 20
6. Click Update. A dialog displays update progress. Click Show details for details of the firmware update process. How to update the firmware of your modules in the XCTU User Guide for more information. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
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 Global Smart Modem User Guide...
Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
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 Global Smart Modem User Guide...
Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
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 Global Smart Modem User Guide...
For more information about MicroPython, see www.micropython.org. For more information about Python, see www.python.org. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
This requires XCTU 6.3.7 or higher. To enter MicroPython mode, follow the steps Use XCTU to enter the MicroPython environment. To use the MicroPython Terminal: Other terminal programs if you do not use the MicroPython Terminal in XCTU. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
2. Press Enter to execute the command. The terminal echos back Hello, World!. Example: turn on an LED 1. Note the DS4 LED on the XBIB board. The following image highlights it in a red box. The LED is normally off. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
3. To turn it off, type the following and press Enter: led.value(1) You have successfully controlled an LED on the board using basic I/O. Exit MicroPython mode To exit MicroPython mode: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
5. Click Setup and Serial Port. The Tera Term: Serial port setup window appears. 6. In the Tera Term: Serial port setup window, set the parameters to the following values: Port: Shows the port that the XBee Smart Modem is connected on. Baud rate: 115200 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
2. Take note of the devices present with that name, and then connect the XBee Smart Modem. 3. Check the directory again and you should see one additional device, which is the XBee Smart Modem. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
5. It should connect and show Terminal ready. Now you can type MicroPython commands at the >>> prompt. More examples The following examples provide some additional scenarios you can try to get familiar with the XBee Smart Modem. Digi XBee3 Cellular LTE-M 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 Global Smart Modem User Guide...
Page 34
Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
This is an example GET request: 44 01 C4 09 74 65 73 74 B7 65 78 61 6D 70 6C 65 The following table describes the fields in the GET request. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 36
Read to get an update on the AI value. Example: manually perform a CoAP request Follow the steps in Configure the device prior to this example. This example performs the CoAP GET request: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 37
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 38
In the following figure, the payload contains the server response to the query. It shows the results for when you press Enter rather than Y. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Yes to confirm. 2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
The following table is an example connect packet: Description Hex value CONNECT packet fixed header byte 1 Control packet type 0x10 byte 2 Remaining length 0x10 CONNECT packet variable header Protocol name Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 41
Clean Session flag, which indicates to the client and broker to discard any previous session and start a new one. Keep Alive How often the client pings the broker to keep the connection alive; in this example it is set to 60 seconds. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 42
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 43
You can verify the response from the broker as a CONNACK by comparing it to the structure of a CONNACK packet in the MQTT documentation, which is available at http://docs.oasis- open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718081). Example: send messages (publish) with MQTT A basic Python example of a node publishing (sending) a message is: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 44
# Create instance of client with client ID “digi_mqtt_test” client.on_connect = on_connect # Define callback function for successful connection client.on_message = on_message # Define callback function for receipt of a message Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 45
XCTU as described in Example: MQTT connect. 4. You can make the proxy with a dual-threaded Python script, a simple version follows: import threading import serial import socket def setup(): """ Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 46
# If the RECV call returns 0 bytes, the socket has closed if (len(data) == 0): print("ERROR - socket has closed. Exiting socket reader thread.") return 1 # Exit the thread to avoid a loop of 0-byte receptions Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 47
MQTT client to use the data connection provided by the device. Think of the proxy script as a translator between the MQTT client and the XBee Smart Modem. The following figure shows the basic operation. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Python and facilitates the development of these types of applications, making it an easy process. The XBee ANSI C Library project is a collection of portable ANSI C code for communicating with the devices in API mode. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 49
Getting started with the XBee Smart Modem Development Kit Software libraries The XBee mbed library is a ready-to-import mbed extension that dramatically reduces development time for XBee projects on mbed platforms. Digi XBee3 Cellular LTE-M 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 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 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 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 Global Smart Modem User Guide...
Page 58
Disabled Analog Input 2 or Digital I/O 2, SPI Clock line 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 Global Smart Modem User Guide...
Less than -103 dBm, or no cellular network Less than connection 45.45% SIM card The XBee Smart Modem uses a 4FF (Nano) size SIM card. CAUTION! Never insert or remove SIM card while the power is on! Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Where the low signal means LED off and the high signal means LED on. When CI is not 0 or 0xFF, the Associate LED has a different blink pattern that looks like this: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
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 Global Smart Modem User Guide...
Design recommendations Cellular component firmware updates USB Direct design Power supply considerations Minimum connection diagram Heat considerations and testing Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
1. Power supply ripple should be less than 75 mV peak to peak. 2. The power supply should be capable of providing a minimum of 750 mA at 3.3 V (2.5 W). Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
1. Set up the device in the typical operating scenario you plan to use it in. 2. Monitor the device temperature using TP (Temperature) until it reaches a steady state. 3. Convert the returned value from hex format to decimal. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 66
Addressing heat issues will help to ensure long term device reliability. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
3. The cellular network may also close the connection after a timeout set by the network operator. Disconnecting When the XBee Smart Modem is put into Airplane mode or deep sleep is requested: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 69
2. The cellular connection is shut down. 3. The cellular component is powered off. Note We recommend entering Airplane mode before resetting or rebooting the device to allow the cellular module to detach from the network. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Modes Select an operating mode Transparent operating mode API operating mode Bypass operating mode USB direct mode Command mode MicroPython mode Digi XBee3 Cellular LTE-M 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 Global Smart Modem User Guide...
Bypass operating mode exists for users who wish to communicate directly with the cellular component settings and do not intend to use XBee Smart Modem software features such as API mode. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
2. Enable based on the state of VBUS (pin 6): Set P0 to 6. Apply a logic high signal to DIO10/PWM0 (pin 6) to enable USB or a logic low signal to disable USB. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
There are two alternative ways to enter Command mode: A serial break for six seconds enters Command mode. You can issue the "break" command from a serial console, it is often a button or menu item. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
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: Digi XBee3 Cellular LTE-M 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 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 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 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 Global Smart Modem User Guide...
In Deep Sleep mode the cellular component is shut off and the XBee processor is put to sleep. Note When the XBee Smart Modem enters deep sleep mode, any MicroPython code currently executing is suspended until the device comes out of sleep. Digi XBee3 Cellular LTE-M 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 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 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 Global Smart Modem User Guide...
Page 85
Enable UART or SPI ports If both ports are disabled on reset, the device uses the UART in spite of the wrong configuration so that at least one serial port is operational. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
SPI operation SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Data format Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
The following diagram shows the frame format mode 0 for SPI communications. SPI mode is chip to chip communication. We do not supply a SPI communication option on the device development evaluation boards. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
SPI slave to start receiving another valid frame. The following figure illustrates the SPI interface while valid data is being sent in both directions. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
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 Global Smart Modem User Guide...
Unable to download via the ATFS GET command or MicroPython's open() method. SHA256 hash of file contents available from ATFS HASH command (to compare with a local copy of a file). Encrypted on the SPI flash. Digi XBee3 Cellular LTE-M 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 Global Smart Modem User Guide...
Page 94
API mode behavior for incoming UDP data Transparent mode behavior for outgoing TCP and SSL connections Transparent mode behavior for outgoing UDP data Transparent mode behavior for incoming TCP connections Transparent mode behavior for incoming UDP connections Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
To send data over this connection use the Transmit (TX) Request: IPv4 - 0x20. 1 TCP socket is used for Remote Manager, so if you have Remote Manager enabled, subtract 1 socket from the values above. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Receive RX frame. In other words: Take the source address, source port, and destination port fields from the Receive (RX) frame and use those respectively as: Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Any data received by this socket is sent out the XBee Smart Modem's serial port. Note Set RO to FF for realtime typing by humans. Also, see TD (Text Delimiter). Digi XBee3 Cellular LTE-M 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 Global Smart Modem User Guide...
For detailed information about using MicroPython on the XBee Smart Modem refer to the Digi MicroPython Programming Guide. TLS AT commands Transparent mode and TLS API mode and TLS Key formats Certificate formats Certificate limitations Cipher suites Server Name Indication (SNI) Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
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 XBee3 Cellular LTE-M Global Smart Modem User Guide...
Certificate formats The XBee3 Cellular LTE-M Global Smart Modem and the XBee Cellular 3G Global Embedded Modem do not support X509 v3 certificates and extensions for the client certificate. However, v3 certificates appear to be fine for CA certificates used in server authentication.
SSL/TLS security layer profile manager +USECPRF heading. The only documented shared suites between the XBee3 Cellular LTE Cat 1 Smart Modem and the XBee3 Cellular LTE-M Global Smart Modem are: TLS_RSA_WITH_AES_128_CBC_SHA...
(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 Global Smart Modem User Guide...
IM (IMEI) Reads the device's International Mobile Equipment Identity (IMEI). Parameter range Default Set in the factory MN (Operator) Reads the network operator on which the device is registered. Parameter range Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
The default setting of 0 (autodetect) increases the boot time. 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 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
From 1 through 127 ASCII characters. Default $1 (SSL/TLS Profile 1) Specifies the SSL/TLS certificate(s) to use for Tx Request with TLS Profile - 0x23 transmissions with profile set to 1. Format server_cert;client_cert;client_key Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
0 the connection is closed immediately after data is sent.] Parameter Range 10 - 0xFFFF; (x 100 ms) Default 0xBB8 (5 minutes) DO (Device Options) Enables and disables special features on the XBee Smart Modem. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Sets or display the fully qualified domain name of the Remote Manager server. Range From 0 through 63 ASCII characters. Default my.devicecloud.com Addressing commands The following AT commands are addressing commands. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
011 for the United States. Range 7 - 20 ASCII digits including an optional + prefix Default N1 (DNS Address) Displays the IPv4 address of the primary domain name server. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
In Transparent or Command mode, the address is represented as a dotted-quad string notation. Parameter range Default 0.0.0.0 DE (Destination Port) Sets or displays the destination IP port number. Parameter range 0x0 - 0xFFFF Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Changes). The baud rate resets to default unless you save it with WR (Write) or by clicking the Write module settings button in XCTU. Parameter range Standard baud rates: 0x1 - 0x8 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Description 0x00 No parity 0x01 Even parity 0x02 Odd parity Default 0x00 SB (Stop Bits) Sets or displays the number of stop bits for UART communications. Parameter range 0 - 1 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
The API mode setting. The device can format the RF packets it receives into API frames and send them out the UART. When API is enabled the UART data must be formatted as API frames because Transparent mode is disabled. See Modes for more information. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Parameter Description Disabled Analog input Digital input Digital output, default low Digital output, default high Default D1 (DIO1/AD1) Sets or displays the DIO1/AD1 configuration (pin 19). Parameter range 0 - 6 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Analog input Digital input Digital output, default low Digital output, default high Default D3 (DIO3/AD3) Sets or displays the DIO3/AD3 configuration (pin 17). Parameter range 0 - 5 Parameter Description Disabled Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Disabled Associated LED Digital input Digital output, default low Digital output, default high Default D6 (DIO6/RTS) Sets or displays the DIO6/RTS configuration (pin 16). Parameter range 0, 1, 3 - 5 Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Digital output, default low Digital output, default high Default D8 (DIO8/SLEEP_REQUEST) Sets or displays the DIO8/DTR/SLP_RQ configuration (pin 9). Parameter range 0, 1, 3 - 5 Parameter Description Disabled SLEEP_REQUEST input Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
This command enables the option of translating incoming data to a PWM so that the output can be translated back into analog form. Parameter range 0 - 6 Parameter Description Disabled RSSI PWM0 output PWM0 output Digital input Digital output, low Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Digital output, default high I2C SDA USB direct Default P2 (DIO12 Configuration) Sets or displays the DIO12 configuration (pin 4). Parameter range 0, 1, 3 - 5 Parameter Description Disabled SPI_MISO Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
The resistor pull direction bit field (1 = pull-up, 0 = pull-down) for corresponding I/O lines that are set PR (Pull-up/down Resistor Enable). If the bit is not set in PR, the device uses PD. Note Resistors are not applied to disabled lines. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
- 9, and P0 - P2 are bits 10 - 12. Analog channel mask. The bits set to 1 are configured for analog I/O and have individual readings following the digital data field. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Parameter Description Normal. In this mode the device never sleeps. Pin Sleep. In this mode the device honors the SLEEP_RQ pin. Set D8 (DIO8/SLEEP_ REQUEST) to the sleep request function: 1. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
0 - 0xFFFF (0 - 65535 [* 1 s]) Default 0xa (10 s) PU (Requested Tracking Area Update Timer) The requested Active Timer for PSM. Note This is related to 3GPP timer T3412. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Immediately exits Command Mode and applies pending changes. Note Whether Command mode is exited using the CN command or by CT timing out, changes are applied upon exit. Parameter range Default Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
32-bit hash. bytecode: the size of bytecode stored in flash and its 32-bit hash. A size of 0 indicates that there is no stored code. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Parameter range 0 - 0xFFFF [read-only] Default Set in firmware VL (Verbose Firmware Version) Shows detailed version information including the application build date and time. Parameter range Default Set in firmware Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Cellular component is in PSM. 0x2F Bypass mode active. 0xFF Initializing. Parameter range 0 - 0xFF [read-only] Default HS (Hardware Series) Read the device's hardware series number. Parameter range Default Set in the firmware Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
The socket is open. 0x01 Tried to send but could not. 0x02 Invalid parameters (bad IP/host). 0x03 TCP not supported on this cellular component. 0x10 Not registered to the cell network. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 132
0x23 No internet connection. 0x24 No server - timed out on connection. 0x25 Unknown server - DNS lookup failed. 0x26 Connection refused. 0x27 Connection lost. 0x28 Unknown. 0xFF No known status. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
API mode or MicroPython's xbee.atcmd() method. Commands are case-insensitive as are file and directory names. Optional parameters are shown in square brackets ([]). FS is a command with sub-commands. These sub-commands are arguments to FS. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Prints the current working directory, which always starts with / and defaults to /flash at startup. ATFS CD directory Changes the current working directory to directory. Prints the current working directory or an error if unable to change to directory. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
If the command is incorrect, the reply will be an error as described in Error responses. ATFS MV source_path dest_path Moves or renames the selected file or directory source_path to the new name or location dest_ path. This command fails with an error if source_path does not exist, or dest_path already exists. Digi XBee3 Cellular LTE-M 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 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 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 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 0x11: XON 0x13: XOFF Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 140
Data field organizes the information. Data contains the data itself. This information and its order depend on the what type of frame that the Frame type field defines. Multi-byte values are sent big-endian. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Byte Command name: two ASCII characters that identify the AT command. command Parameter Byte If present, indicates the requested parameter value to set the given value register. If no characters are present, it queries the register. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
(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 Global Smart Modem User Guide...
If there is no matching socket, the TX Status frame returns an error. Protocol Byte 0 = UDP 1 = TCP 4 = SSL/TLS Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 146
Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
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 Global Smart Modem User Guide...
Page 148
Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Status 1 = ERROR 2 = Invalid command 3 = Invalid parameter Parameter Byte Register data in binary format. If the register was set, then this field is value not returned. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Message too long 0x78 Invalid UDP port 0x79 Invalid TCP port 0x7A Invalid host address 0x7B Invalid data mode 0x80 Connection refused 0x81 Socket connection lost 0x82 No server 0x83 Socket closed Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 151
API frames Transmit (TX) Status - 0x89 Code Description 0x84 Unknown server 0x85 Unknown error 0x86 Invalid TLS configuration (missing file, and so forth) Digi XBee3 Cellular LTE-M 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 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 Global Smart Modem User Guide...
Digi Remote Manager. Note Digi is consolidating our cloud services, Digi Device Cloud and Digi Remote Manager®, under the Remote Manager name. This phased process does not affect device functionality or the functionality of the web services and other features. However, customers will find that some user interface and firmware functionality mention both Device Cloud and Digi Remote Manager.
Create a Remote Manager account 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 detailed information on using Remote Manager, refer to the Remote Manager User Guide, available via the Documentation tab in Remote Manager.
# Location of firmware image on Remote Manager firmware_path = '~/XBXC.ebin' # 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" Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Page 159
<device id="{}"/> </targets> <file>{}</file> </update_firmware> </sci_request> """.format(device_id, firmware_path) # 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 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 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 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 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 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 Global Smart Modem User Guide...
Brownout issue The XBee3 RF Module uses a Silicon Labs EFR32MG System on Chip (SoC). Silicon Labs has announced an intermittent restarting issue with EFR32MG revision B SoCs which can be caused by voltage brownout or supply dips during power-on.
UART connection to match any changes to the AT+IPR setting of the cellular component. We suggest that customers interested in Bypass mode consider using direct USB mode. Socket leaks This applies to devices with the u-blox SARA-R410 cellular component used in the XBee3 Cellular LTE-M Global Smart Modem. Condition There are instances where a socket leaks when closing a connection while there is pending RX data.
Socket leaks Solution To recover the leaked sockets and make them available again in all modes: Perform a reset of the cellular component (hard or soft). Send an AT!R—see !R (Modem Reset). Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Regulatory information United States (FCC) Innovation, Science and Economic Development Canada (ISED) Digi XBee3 Cellular LTE-M 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.
7.12 dBi in 1900 MHz, i.e. LTE FDD-2 band RF exposure If you are an integrating the XBee3 RF Module into another product, you must include the following Caution statement in OEM product manuals to alert users of FCC RF exposure compliance:...
Page 172
Canada. Dans le but de réduire les risques de brouillageradioélectrique à l'intention des autres utilisateurs, il faut choisir le type d'antenne etson gain de sorte que la puissance isotrope rayonnée équivalente (p.i.r.e.) ne dépassepas l'intensité nécessaire àl'établissement d'une communication satisfaisante. Digi XBee3 Cellular LTE-M Global Smart Modem User Guide...
Need help?
Do you have a question about the XBee3 and is the answer not in the manual?
Questions and answers