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
+1 952.912.3444 or visit us at www.digi.com/support. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Contents Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide Applicable firmware and hardware SIM cards Get started with the XBee Cellular Modem Development Kit Identify the kit contents Connect the hardware XBIB-U-DEV reference Cellular service Configure the device using XCTU...
Page 5
Use MQTT over the XBee Cellular Modem with a PC Software libraries Get started with MicroPython About MicroPython Why use MicroPython MicroPython on the XBee Cellular Modem Use XCTU to enter the MicroPython environment Use the MicroPython Terminal in XCTU...
Page 6
Cyclic sleep with pin wake up mode Airplane mode The sleep timer MicroPython sleep behavior Serial communication Serial interface Serial data UART data flow Serial buffers CTS flow control RTS flow control Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 7
API mode and TLS Key formats Certificate formats Certificate limitations Cipher suites Server Name Indication (SNI) AT commands Special commands AC (Apply Changes) FR (Force Reset) RE command WR (Write) Cellular commands Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 9
API mode overview Use the AP command to set the operation mode API frame format API operation (AP parameter = 1) API operation with escaped characters (AP parameter = 2) Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 10
Update the firmware Update the firmware using web services Example: update the XBee firmware synchronously with Python 3.0 Example: use the device's firmware image to update the XBee firmware synchronously Troubleshooting Cannot find the serial port for the device Condition...
Page 11
Syntax error at line 1 Solution Error Failed to send SMS Solution Regulatory information Modification statement Interference statement FCC Class B digital device notice Labeling requirements for the host device Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
XBC-V1-UT-xxx SIM cards If you order the wrong type of SIM card it will not work with the XBee Cellular Modem. Verizon recommends SIM SKU: M2MTRI-NONRUG-GT-A or an equivalent that must include a 4FF punch out. This SKU is in triple punch, so devices with 2FF/3FF or 4FF can use this SIM SKU.
Page 13
Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide SIM cards Phone National distributor Network Contact number Email Reliance raja.ali@reliance.us Verizon Raja Ali 917-517- Communications direct 7282 Ingram Micro - Sales lesli.reeves@ingrammicro.com Verizon Lesli Reeves 317-707- direct 2371 Ingram Micro - Sales steve.kreiger@ingrammicro.com...
Get started with the XBee Cellular Modem Development Kit This section describes how to connect the hardware in the XBee Cellular Modem Development Kit, and provides some examples you can use to communicate with the device. Identify the kit contents...
One 12 V power supply Two cellular antennas with U.FL connectors One USB cable One XBee Cellular Modem Note The XBee Cellular Modem comes attached to the board in ESD wrap. One SIM card Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Connect the hardware 1. The XBee Cellular Modem should already be plugged into the XBIB-U-DEV board. 2. The SIM card should be already be inserted into the XBee Cellular Modem. If not, install the SIM card into the XBee Cellular Modem. WARNING! Never insert or remove the SIM card while the device is powered! 3.
Page 17
5. Connect the USB cable from a PC to the USB port on the development board. The computer searches for a driver, which can take a few minutes to install. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Get started with the XBee Cellular 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 XBee Cellular LTE Cat 1 Embedded 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.
2. Click Help > Check for XCTU Updates to ensure you are using the latest version of XCTU. 3. Click the Discover radio modules button 4. In the Discover radio devices dialog, select the serial ports where you want to look for XBee modules, and click Next.
Check for cellular registration and connection In the following examples, proper cellular network registration and address assignment must occur successfully. The LED on the development board blinks when the XBee Cellular Modem is registered to the cellular network; see The Associate LED.
Page 22
4. Make sure you check the Force the module to maintain its current configuration box and then click Update. 5. Select the product family of the XBee module, the function set, and the latest firmware version. 6. Click Update. A dialog displays update progress. Click Show details for details of the firmware update process.
Connection examples The following examples provide some additional scenarios you can try to get familiar with the XBee Cellular Modem. Connect to the Echo server Connect to the ELIZA server Connect to the Daytime server Send an SMS message to a phone...
5. To switch to TCP communication, in the IP field, select 1 and click the Write button 6. To enable the XBee Cellular Modem to recognize carriage return as a message delimiter, in the TD field, type D and click the Write button.
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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Connect to the ELIZA server Connect to the ELIZA server You can use the XBee Cellular Modem to chat with the ELIZA Therapist Bot. ELIZA is an artificial intelligence (AI) bot that emulates a therapist and can perform simple conversations. The following table explains the AT commands that you use in this example.
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 XBee Cellular LTE Cat 1 Embedded 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 XBee Cellular LTE Cat 1 Embedded 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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
+ prefix if necessary. The target phone number is the phone number you wish to send a text to. 7. In the TD field, type D and click the Write button. 8. Note the number in the PH field; it is the XBee Cellular Modem phone number, which you see when it sends an SMS to your phone.
Send an SMS message to a phone 11. Click in the left pane of the Console log, type hello world and press Enter. The XBee Cellular Modem sends the message to the destination phone number set by the P# command.
Perform a (GET) HTTP request Perform a (GET) HTTP request You can use the XBee Cellular Modem to perform a GET Hypertext Transfer Protocol (HTTP) request using XCTU. HTTP is an application-layer protocol that runs over TCP. This example uses httpbin.org/...
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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Constrained Application Protocol (CoAP) is based on UDP connection and consumes low power to deliver similar functionality to HTTP. This guide contains information about sending GET, POST, PUT and DELETE operations by using the Coap Protocol with XCTU and Python code working with the XBee Cellular Modem and Coapthon library (Python 2.7 only).
5. To switch to UDP communication, in the IP field, select 0 and click the Write button 6. To set the target IP address that the XBee Cellular Modem will talk to, in the DL field type 52.43.121.77and click the Write button .
This example illustrates how the CoAP protocol can perform GET/POST/PUT/DELETE requests similarly to the HTTP protocol and how to do this using the XBee Cellular Modem. In this example, the XBee Cellular 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 Cellular Modem to talk to the remote CoAP server.
Page 37
COM19, type 19. Note If you do not know the port number, open XCTU and look at the XBee Cellular Modem in the Radio Modules list. This view provides the port number and baud rate, as in the figure below where the baud rate is 9600 b/s.
Page 38
Connection examples Get started with CoAP Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Connection examples Connect to a TCP/IP address Connect to a TCP/IP address The XBee Cellular Modem can send and receive TCP messages while in Transparent mode; see Transparent operating mode. Note You can use this example as a template for sending and receiving data to or from any TCP/IP server.
Page 40
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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
The first two MQTT examples do not involve the XBee Cellular Modem. They demonstrate using the MQTT libraries because those libraries are required for...
Page 42
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 XBee Cellular LTE Cat 1 Embedded 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.
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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
# 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 Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
2. Set DL to the IP address of the broker you want to use. 3. Set DE to the port to use, the default is 1883 (0x75B). This sets the XBee Cellular Modem to communicate directly with the broker, and can be performed in XCTU as described in...
Page 47
""" global clisock, cliaddr, svrsock, ser # Change this to the COM port your XBee Cellular module is using. # Linux, this will be /dev/ttyUSB# comport = 'COM44' # This is the default serial communication speed of the XBee Cellular...
Page 48
(clisock), it creates two threads, one that reads the serial or COM port that the XBee Cellular Modem is connected to, and one that reads the socket (clisock), that the MQTT client is connected to.
Cellular Modem. You are able to see your published message appear in the subscribe script’s output once it is received from the broker via the XBee Cellular Modem. If you watch the output of the proxy script during this process you can see the receptions and transmissions taking place.
Get started with MicroPython This guide provides an overview of how to use MicroPython with the XBee Cellular Modem. For in- depth information and more complex code examples, refer to the Digi MicroPython Programming Guide. Continue with this guide for simple examples to get started using MicroPython on the XBee Cellular Modem.
COM port in use. Use the MicroPython Terminal in XCTU You can use the MicroPython Terminal to communicate with the XBee Cellular Modem when it is in MicroPython mode. This requires XCTU 6.3.7 or higher. To enter MicroPython mode, follow the steps Use XCTU to enter the MicroPython environment.
= Pin("D4", Pin.OUT, value=0) # Makes a pin object set to output 0. # One might expect 0 to mean OFF and 1 to mean ON, and this is normally the case. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Many stores have help buttons in their aisles that a customer can press to alert the store staff that assistance is required in that aisle. You can implement this type of system using the Digi XBee Cellular Modem, and this example provides the building blocks for such a system. This example, based on SMS...
For this part of the example, you write code that responds to a button press on the XBIB-U-DEV board that comes with the XBee Cellular Modem Development Kit. The code monitors the pin connected to the button on the board labeled SW2.
SW2 press...") while (True): if (dio0.value() == 0): # When SW2 is pressed, the module will send an SMS # message saying "Button pressed" to the given target cell phone Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
# While no network connection. print("Waiting for connection to cell network...") time.sleep(5) print("Connected.") # Give feedback to inform user a button press is needed. print("Waiting for SW2 press...") while (1): if (dio0.value() == 0): Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Use caution with the PDF version, as it may not maintain essential indentations. Now you have a system based on the XBee Cellular Modem that sends an SMS in response to a certain input, in this case a simple button press.
Get started with MicroPython Other terminal programs Tera Term for Windows With the XBee Cellular Modem in MicroPython mode (AP = 4), you can access the MicroPython prompt using a terminal. 1. Open Tera Term. The Tera Term: New connection window appears.
Use picocom in Linux Now you can type MicroPython commands at the >>> prompt. Use picocom in Linux With the XBee Cellular Modem in MicroPython mode (AP = 4), you can access the MicroPython prompt using a terminal. Note The user must have read and write permission for the serial port the XBee Cellular Modem is connected to in order to communicate with the device.
Page 60
Get started with MicroPython Use picocom in Linux Now you can type MicroPython commands at the >>> prompt. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
4 and 13 Security SSL/TLS Power requirements The following table provides the power requirements for the device. Specification Value Supply voltage 3.0 to 5.5 V Extended voltage range 2.7 to 5.5 VDC Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
143 mA Idle current Idle/connected, listening @ 5 V 100 mA Sleep current Not connected, Deep Sleep @ 3.3 V 10 µA Electrical specifications The following table provides the electrical specifications for the XBee Cellular Modem. Symbol Parameter Condition Typical Max Units VCCMAX Maximum limits of VCC line Min ...
The following table provides the regulatory and carrier approvals for the device. Specification Value United States Contains FCC ID: RI7LE866SV1 Innovation, Science and Economic Development Canada (ISED) Contains IC: 5131A-LE866SV1 Europe (CE) RoHS Lead-free and RoHS compliant Australia Verizon end-device certified Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Hardware Mechanical drawings Mechanical drawings The following figures show the mechanical drawings for the XBee Cellular Modem. All dimensions are in inches. Pin signals The pin locations are: The following table shows the pin assignments for the through-hole device. In the table, low-asserted signals have a horizontal line above signal name.
Page 67
Analog Input 2 or Digital I/O 2, SPI Clock line AD1 / DIO1 / SPI_ATTN Analog Input 1 or Digital I/O Either Disabled 1, SPI Attention line output AD0 / DIO0 Either Input Analog Input 0, Digital I/O 0 Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
The recommended minimum pin connections are VCC, GND, DIN, DOUT, RTS, DTR and RESET. Firmware updates require access to these pins. RSSI PWM The XBee Cellular Modem features an RSSI/PWM pin (pin 6) that, if enabled, adjusts the PWM output to indicate the signal strength of the cellular connection. Use P0 (DIO10/PWM0 Configuration) to enable the RSSI pulse width modulation (PWM) output on the pin.
Page 69
Where the low signal means LED off and the high signal means LED on. When CI is not 0 or 0xFF, the Associate LED has a different blink pattern that looks like this: Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
The XBee Cellular Modem has two U.FL antenna ports; a primary on the upper left of the board and a secondary port on the upper right, see the drawing below. You must connect the primary port and the secondary port is optional.
Antenna placement Antenna placement It is important to keep the antenna as far away from the XBee Cellular Modem and other metal objects as possible. Often, small antennas are desirable, but at the cost of increasing size of dead zones because of reduced range and efficiency.
Page 73
Design recommendations Power supply considerations Add a capacitor to the RESET line Heat considerations and testing Heat sink guidelines Add a fan to provide active cooling Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
We recommend that the power supply and trace be designed such that the voltage at the XBee VCC pin does not vary by more than 0.1 V between light load (~0.5 W) and heavy load (~3 W).
Page 75
The TP reading may not be calibrated. To compensate for this you can determine an offset to use in the equations above as follows: With the XBee Cellular Modem not powered, allow it to sit at room temperature for 15 - 20 minutes. Power the device and immediately read the TP command. Convert the TP reading from hex format to decimal and subtract the result from the actual room temperature.
Based on the results of your thermal testing you may find it is advisable or required to implement a method of dissipating excess heat. This section explains how to employ a heat sink on top of the XBee Cellular Modem.
Another option for heat mitigation is to add a fan to your system to provide active cooling. You can use a fan instead of or in addition to a heat sink. The XBee Cellular Modem offers a fan control feature on I/O pin DIO11 (pin 7).
Page 78
Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting SMS encoding Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
3. The cellular network may also close the connection after a timeout set by the network operator. Disconnecting When the XBee Cellular Modem is put into Airplane mode or deep sleep is requested: Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
GSM 03.38 character set. Because this character set only provides 7 bits of space per character, the XBee Cellular Modem ignores the most significant bit of each octet in an SMS transmission payload. The device converts incoming SMS messages to ASCII. Characters that cannot be represented in ASCII are replaced with a space (' ', or 0x20 in hex).
Modes Select an operating mode Select an operating mode The XBee Cellular Modem interfaces to a host device such as a microcontroller or computer through a logic-level asynchronous serial port. It uses a UART for serial communication with those devices.
In Bypass mode, the device acts as a serial line replacement to the cellular component. In this mode, the XBee Cellular Modem exposes all control of the cellular component's AT port through the UART. If you use this mode, you must setup the cellular modem directly to establish connectivity. The modem does not automatically connect to the network.
AT commands. When you want to read or set any parameter of the XBee Cellular Modem using this mode, you have to send an AT command. Every AT command starts with the letters AT followed by the two characters that identify the command and then by some optional configuration values.
Multiple AT commands You can send multiple AT commands at a time when they are separated by a comma in Command mode; for example, ATNIMy XBee,AC<cr>. The preceding example changes the NI (Node Identifier) to My XBee and makes the setting active through AC (Apply Changes).
MicroPython mode MicroPython mode (AP = 4) allows you to communicate with the XBee Cellular Modem using the MicroPython programming language. You can use the MicroPython Terminal tool in XCTU to communicate with the MicroPython stack of the XBee Cellular Modem through the serial interface.
Page 87
MicroPython mode When code runs in MicroPython with AP set to a value other than 4, stdout goes to the bit bucket and there is no input to read on stdin. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
While not technically a sleep mode, Airplane mode is another way of saving power. When set, the cellular component of the XBee Cellular Modem is fully turned off and no access to the cellular network is performed or possible. Use AM (Airplane Mode) to configure this mode.
When the XBee Cellular Modem enters Deep Sleep mode, any MicroPython code currently executing is suspended until the device comes out of sleep. When the XBee Cellular Modem comes out of sleep mode, MicroPython execution continues where it left off.
Serial communication Serial interface Serial data UART data flow Serial buffers CTS flow control RTS flow control Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Serial communication Serial interface Serial interface The XBee Cellular Modem interfaces to a host device through a serial port. The device's serial port can communicate: Through a logic and voltage compatible universal asynchronous receiver/transmitter (UART). Through a level translator to any serial device, for example, through an RS-232 or USB interface board.
Serial buffers Serial buffers The XBee Cellular Modem maintains internal buffers to collect serial and RF data that it receives. The serial receive buffer collects incoming serial characters and holds them until the device can process them. The serial transmit buffer collects the data it receives via the RF link until it transmits that data out the serial or SPI port.
SPI operation SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Data format Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
SPI communications SPI communications The XBee Cellular Modem supports SPI communications in slave mode. Slave mode receives the clock signal and data from the master and returns data to the master. The following table shows the signals that the SPI port uses on the device.
This allows the SPI slave to alert the SPI master that it has data to send. In turn, the SPI master is expected to assert SPI_SSEL and start SPI_CLK, unless these signals are already asserted and active respectively. This, in turn, allows the XBee Cellular Modem SPI slave to send data to the master.
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.
Data format SPI only operates in API mode 1. The XBee Cellular Modem does not support Transparent mode or API mode 2 (which escapes control characters). This means that the AP configuration only applies to the UART, and the device ignores it while using SPI.
Page 99
File system For detailed information about using MicroPython on the XBee Cellular Modem refer to the Digi MicroPython Programming Guide. Overview of the file system XCTU interface Encrypt files Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Paths The XBee Cellular Modem stores all of its files in the top-level directory /flash. On startup, the ATFS commands and MicroPython each use that as their current working directory. When specifying the path to a file or directory, it is interpreted as follows: Paths starting with a forward slash are "absolute"...
PUT operation. Files placed in this way are indicated with a pound sign (#) following the filename. The XBee Cellular Modem does not allow an encrypted file to be read by normal use so it: 1. Cannot be retrieved with the GET operation.
Page 102
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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
10 maximum: some combination of 6 TCP, 6 UDP, 6 SSL. Socket timeouts The XBee Cellular Modem implicitly opens the socket any time there is data to be sent, and closes it according to the timeout settings. The TM (IP Client Connection Timeout) command controls the timeout settings.
A status of 0 indicates the connection and/or data was successful and a non-zero value indicates a failure. Any data received on the connection is sent out the XBee Cellular Modem's serial port as a Receive RX frame.
When the IP setting is TCP the XBee Cellular Modem allows multiple incoming TCP connections on the port specified by the C0 setting. Any data received on the connection is sent out the XBee Cellular Modem's serial port as a Receive (RX) Packet: IPv4 - 0xB0 frame.
Transparent mode behavior for outgoing UDP data Transparent mode behavior for outgoing UDP data To send outgoing UDP data to a remote host, send data to the XBee Cellular Modem's serial port. If (Protocol/Connection Indication) reports a value of 0, the data was successfully sent; otherwise, the value of CI indicates why the data failed to be sent.
Transport Layer Security (TLS) For detailed information about using MicroPython on the XBee Cellular 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...
2. Server authentication: Only ca_cert is provided. Only the servers identity is checked 3. Mutual authentication: All items are provided and both sides are assured of the identity of their peer It is not possible to only have client authentication. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
IP setting for the serial data. Key formats 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.
Server Name Indication (SNI) We do not currently support SNI. Therefore servers which use SNI to present certificates based on client provided host data may be unable to establish the expected connections. Digi XBee Cellular LTE Cat 1 Embedded 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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
The following AT commands are cellular configuration and data commands. PH (Phone Number) Reads the SIM card phone number. If PH is blank, the XBee Cellular Modem is not registered to the network. Parameter range Default Set by the cellular carrier via the SIM card S# (ICCID) Reads the Integrated Circuit Card Identifier (ICCID) of the inserted SIM.
Set in the currently loaded firmware DB (Cellular Signal Strength) Reads the absolute value of the current signal strength to the cell tower in dB. If DB is blank, the XBee Cellular Modem has not received a signal strength from the cellular component.
AT&T Verizon Default AM (Airplane Mode) When set, the cellular component of the XBee Cellular Modem is fully turned off and no access to the cellular network is performed or possible. Parameter range 0 - 1 0 = Normal operation...
AT commands Network commands This setting is applied only while the XBee Cellular Modem is initializing the cellular component. After changing this setting, you must: 1. Use WR (Write) to write all values to flash. 2. Use FR (Force Reset) to reset the device.
Specifies the SSL/TLS certificate(s) to use in Transparent mode (when IP (IP Protocol) = 4) or API mode (Transmit (TX) Request: IPv4 - 0x20 Tx Request with TLS Profile - 0x23 with profile set to 0). Format server_cert;client_cert;client_key Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Enables and disables special features on the XBee Cellular Modem. Bit 0 - Remote Manager support If the XBee Cellular Modem cannot establish a connection with Remote Manager, it waits 30 seconds before trying again. On each successive connection failure, the wait time doubles (60 seconds, 120, 240, and so on) up to a maximum of 1 hour.
The lower digits of the unique International Mobile Equipment Identity (IMEI) assigned to this device. Parameter range 0 - 0xFFFFFFFF [read-only] Default MY (Module IP Address) Reads the device's IP address. This command is read-only because the IP address is assigned by the mobile network. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
To set the destination address to an IP address, the value must be a dotted quad, for example XXX.XXX.XXX.XXX. To set the destination address to a domain name, the value must be a legal Internet host name, for example remotemanager.digi.com Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Set or get the port number used to provide the serial communication service. Data received by this port on the network is transmitted on the XBee Cellular Modem's serial port. As long as a network connection is established to this port (for TCP) data received on the serial port is transmitted on the established network connection.
BD (Baud Rate) Sets or displays the serial interface baud rate for communication between the device's serial port and the host. Modified interface baud rates do not take effect until the XBee Cellular Modem exits Command mode or you issue AC (Apply Changes).
The ASCII character used as a text delimiter for Transparent mode. When you select a character, information received over the serial port in Transparent mode is not transmitted until that character Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
API enabled (with escaped control characters) 0x03 0x04 MicroPython REPL 0x05 Bypass mode Default I/O settings commands The following AT commands are I/O settings commands. D0 (DIO0/AD0) Sets or displays the DIO0/AD0 configuration (pin 20). Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Parameter Description Disabled SPI_ATTN Digital input Digital output, low Digital output, high I2C SCL Default D2 (DIO2/AD2) Sets or displays the DIO2/AD2 configuration (pin 18). Parameter range 0 - 5 Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Digital output, default high Default D6 (DIO6/RTS) Sets or displays the DIO6/RTS configuration (pin 16). Parameter range 0, 1, 3 - 5 Parameter Description Disabled RTS flow control Digital input Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
I/O settings commands Parameter Description Disabled Fan enable. Output is low when the XBee Cellular Modem is sleeping, turning an attached fan off when the cellular component is in a power saving mode, and also during Airplane Mode Digital input...
M0 (PWM0 Duty Cycle) Sets the duty cycle of PWM0 (pin 6) for P0 = 2, where a value of 0x200 is a 50% duty cycle. Before setting the line as an output: Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
The following AT commands configure I/O sampling parameters. TP (Temperature) Displays the temperature of the XBee Cellular Modem in degrees Celsius. The temperature value is displayed in 8-bit two’s complement format. For example, 0x1A = 26 °C, and 0xF6 = -10 °C.
Cyclic Sleep with Pin Wake. In this mode the device acts as in Cyclic Sleep but does not sleep if the SLEEP_RQ pin is inactive, allowing the device to be kept awake or woken by the connected system. Default Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Sets or displays the Command mode timeout parameter. If a device does not receive any valid commands within this time period, it returns to Idle mode from Command mode. Parameter range 2 - 0x1770 (x 100 ms) Default 0x64 (10 seconds) Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
0x3E8 (one second) MicroPython commands The following commands relate to using MicroPython on the XBee Cellular Modem. PS (Python Startup) Sets whether or not the XBee Cellular Modem runs the stored Python code at startup. Range 0 - 1 Parameter Description Do not run stored Python code at startup.
The firmware version returns four hexadecimal values (2 bytes) ABCD. Digits ABC are the main release number and D is the revision number from the main release. B is a variant designator where 0 means standard release. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Displays the current Remote Manager status for the XBee. Range Value Description 0x00 Connected 0x01 Before connection to the Internet 0x02 Remote Manager connection in progress 0x03 Disconnecting from Remote Manager 0x04 Not configured for Remote Manager Default Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
The following table provides the parameter's meaning when IP = 1 or 4 for TCP connections. Parameter Description 0x00 The socket is open. 0x01 Tried to send but could not. 0x02 Invalid parameters (bad IP/host). Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 140
No network registration. 0x11 Cellular component stack error. 0x13 Socket leak 0xFF No SMS state to report (no SMS messages have been sent). Parameter range 0 - 0xFF (read-only) Default Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
NR (Network Reset) NR resets the network layer parameters. The XBee Cellular Modem responds immediately with an OK on the UART and then causes a network restart. If NR = 0, the XBee Cellular Modem tears down any TCP/UDP sockets and resets Internet connectivity.
Starts a YMODEM receive on the XBee Cellular Modem, storing the received file to filename and ignoring the filename that appears in block 0 of the YMODEM transfer. The XBee Cellular Modem sends a prompt (Receiving file with YMODEM...) when it is ready to receive, at which point you should initiate a YMODEM send in your terminal emulator.
-hashfile test.txt SHA256. On Mac and Linux use shasum -b -a 256 test.txt. ATFS GET filename Starts a YMODEM send of filename on the XBee device. When it is ready to send, the XBee Cellular Modem sends a prompt: (Sending file with YMODEM...). When the prompt is sent, you should initiate a YMODEM receive in your terminal emulator.
Page 144
Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Digi XBee Cellular LTE Cat 1 Embedded 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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
1 byte Any data received prior to the start delimiter is silently discarded. If the frame is not received correctly or if the checksum fails, the XBee replies with a radio status frame indicating the reason for the failure. API operation with escaped characters (AP parameter = 2) Setting API to 2 allows escaped control characters in the API frame.
Page 147
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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 148
Subtract 0x47 from 0xFF and you get 0x3B (0xFF - 0xC4 = 0x3B). 0x3B is the checksum for this data packet. If an API data packet is composed with an incorrect checksum, the XBee Cellular Modem will consider the packet invalid and will ignore the data.
Page 149
Tx Request with TLS Profile - 0x23 AT Command Response - 0x88 Transmit (TX) Status - 0x89 Modem Status - 0x8A Receive (RX) Packet: SMS - 0x9F Receive (RX) Packet: IPv4 - 0xB0 Digi XBee Cellular LTE Cat 1 Embedded 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 XBee Cellular LTE Cat 1 Embedded 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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
0 - Leave the socket open. Closed by timeout, see TM (IP Client Connection Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 153
API frames Transmit (TX) Request: IPv4 - 0x20 Field Field name value Data type Description Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
0 - Leave the socket open. Closed by timeout, see TM (IP Client Connection Timeout). Ignore this bit for UDP packets. All other bits are reserved and should be 0. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 155
API frames Tx Request with TLS Profile - 0x23 Field Field name value Data type Description Payload Variable Data to be transferred to the destination, may be up to 1500 bytes. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
1 = ERROR 2 = Invalid command 3 = Invalid parameter Parameter Byte Register data in binary format. If the register was set, then this field is value not returned. Digi XBee Cellular LTE Cat 1 Embedded 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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 158
API frames Transmit (TX) Status - 0x89 Code Description 0x84 Unknown server 0x85 Unknown error 0x86 Invalid TLS configuration (missing file, and so forth) Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Receive (RX) Packet: SMS - 0x9F Receive (RX) Packet: SMS - 0x9F Description This XBee Cellular Modem uses this frame when it receives an SMS message. Format The following table provides the contents of the frame. For details on frame structure, see API frame format.
Receive (RX) Packet: IPv4 - 0xB0 Receive (RX) Packet: IPv4 - 0xB0 Description The XBee Cellular Modem uses this frame when it receives RF data on a network socket that is created by a TX request frame or configuring C0 (Source Port).
Page 162
Packaged firmware updates You can perform packaged firmware updates on part number XBC-V1-UT-001 (Digi XBee Cellular Verizon LTE Cat 1) modules only. About packaged firmware updates FW Update - 0x2B FW Update Response - 0xAB Important notes Perform a cellular component firmware update...
15-20 minutes to complete. A host program that performs packaged firmware updates over the XBee Cellular Modem's serial interface is required to know of the association between module firmware and cellular component firmware as shown in...
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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Once it is determined that a cellular component update is needed, the bootloader (part number 82004156) should be updated followed by the cellular code (part number 82004015). Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
0x24. If you see this status, reset the module (using FR for example) and then follow the steps in Perform a cellular component firmware update to redo the cellular component firmware update. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
General case Regardless of the reason for the error, a cellular component firmware update should always work within ten seconds of a reset and after AI is 0x23 or 0. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Use Digi Remote Manager (https://remotemanager.digi.com/) to perform the operations in this section. Each operation requires that you enable Remote Manager with the DO command and that you connect the XBee Cellular Modem to an access point that has an external Internet connection to allow access to Digi Remote Manager.
2. Click Device Management > Devices. 3. Click Add Devices. The Add Devices dialog appears. 4. Select IMEI #, and type or paste the IMEI number of the XBee you want to add. The (IMEI) command provides this number. 5. Click Add to add the device. The XBee is added to your inventory.
Configure the XBee Cellular Modem using Digi Remote Manager Update the firmware Update the firmware XBee Cellular Modem supports Remote Manager firmware updates. To perform a firmware update: 1. Download the updated firmware file for your device from Digi's support site.
Example: use the device's firmware image to update the XBee firmware synchronously To update the XBee firmware synchronously with Python 3.0, but using the device firmware image already uploaded to Remote Manager, upload the device's *.ebin firmware to Remote Manager: 1.
Page 172
</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 XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Troubleshooting This section contains troubleshooting steps for the XBee Cellular Modem. Cannot find the serial port for the device Correct a macOS Java error Unresponsive cellular component in Bypass mode Not on expected network after APN change Syntax error at line 1...
4. Remove the development board from the USB port and view which port name no longer appears in the Discover radio devices list of ports. The port name that no longer appears is the correct port for the development board. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
2. Type Device Manager to search for it. 3. Click Universal Serial Bus controllers. 4. If it displays more than one USB controller, unplug the XBee Cellular Modem and plug it back in to make sure you choose the correct one.
1. Click More info to open a browser window. 2. Click Download to get the file javaforosx.dmg. 3. Double-click on the downloaded javaforosx.dmg. 4. In the dialog, double-click the JavaForOSX.pkg and follow the instructions to install Java. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Troubleshooting Unresponsive cellular component in Bypass mode Unresponsive cellular component in Bypass mode When in Bypass mode, the XBee Cellular Modem does not automatically reset or reboot the cellular component if it becomes unresponsive. Condition In Bypass mode, the XBee Cellular Modem does not respond to commands.
Troubleshooting Not on expected network after APN change Not on expected network after APN change Condition The XBee Cellular Modem is not on the expected network after a change to the AN (Access Point Name) command. Solution Send ATNR0 to reset Internet connectivity. See NR (Network Reset) for more information.
Page 179
Regulatory information Modification statement Interference statement FCC Class B digital device notice Labeling requirements for the host device Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Page 180
Modification statement Modification statement Digi International has not approved any changes or modifications to this device by the user. Any changes or modifications could void the user’s authority to operate the equipment. Digi International n’approuve aucune modification apportée à l’appareil par l’utilisateur, quelle qu’en soit la nature.
Page 181
Contains IC: 5131A-LE866SV1 CAN ICES-3 (B) / NMB-3 (B) This Class B digital apparatus complies with Canadian ICES-003. Cet appareil numérique de classe B est conforme à la norme canadienne ICES-003. Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...
Need help?
Do you have a question about the XBee and is the answer not in the manual?
Questions and answers