Digi XBee3® Cellular LTE Cat 1 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.
Contents Digi XBee3 Cellular LTE Cat 1 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
Data network connection Data communication with remote servers (TCP/UDP) Disconnecting SMS encoding Modes Select an operating mode Transparent operating mode API operating mode Bypass operating mode Enter Bypass operating mode Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 5
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 Socket behavior Supported sockets Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 6
$1 (SSL/TLS Profile 1) $2 (SSL/TLS Profile 2) TM (IP Client Connection Timeout) TS (IP Server Connection Timeout) DO (Device Options) EQ (Remote Manager FQDN) Addressing commands SH (Serial Number High) Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 8
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 Update the firmware Update the firmware using web services Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 9
Regulatory information Modification statement Interference statement FCC Class B digital device notice RF exposure FCC-approved antennas Bluetooth antennas Dipole antennas Flex PCB antennas Cellular antennas Labeling requirements for the host device Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide 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.
Cellular service Configure the device using XCTU Send an SMS message to a phone Connect to the ELIZA server Connect to the Echo server Connect to the Daytime server More examples Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
One 12 V power supply Two cellular antennas with U.FL connectors One USB cable One XBee Smart Modem Note The XBee Smart Modem comes attached to the board in ESD wrap. One SIM card Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
We recommend using a U.FL removal tool. 4. Plug the 12 V power supply to the power jack on the development board. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 14
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 Cat 1 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 Cat 1 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 XBee module from the Radio Modules list. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 19
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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
2. Factory settings are loaded but not written to the device. To write them, click the Write button on the toolbar. More examples The following examples provide some additional scenarios you can try to get familiar with the XBee Smart Modem. Digi XBee3 Cellular LTE Cat 1 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 Cat 1 Smart Modem User Guide...
Page 29
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 Cat 1 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 Cat 1 Smart Modem User Guide...
Page 31
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 Cat 1 Smart Modem User Guide...
Page 32
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 33
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 Cat 1 Smart Modem User Guide...
If you experience problems with the settings in this example, you can load the default settings in XCTU: 1. On the Configuration toolbar, click the Default button to load the default values established by the firmware, and click Yes to confirm. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 35
Getting started with the XBee Smart Modem Development Kit More examples 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 Cat 1 Smart Modem User Guide...
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 Cat 1 Smart Modem User Guide...
Page 37
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 Cat 1 Smart Modem User Guide...
Page 38
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 39
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 Cat 1 Smart Modem User Guide...
Page 40
# 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 Cat 1 Smart Modem User Guide...
Page 41
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 Cat 1 Smart Modem User Guide...
Page 42
# 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 Cat 1 Smart Modem User Guide...
Page 43
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 Cat 1 Smart Modem User Guide...
Page 44
To avoid these errors, it is best to start the scripts in the correct order: proxy, then subscribe, then publish. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
The XBee Smart Modem is connected to the computer via a USB cable and XCTU recognizes it. The board is powered by an appropriate power supply, 12 VDC and at least 1.1 A. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
You can use the +++ escape sequence and look for an OK for confirmation that you have the correct baud rate. Other terminal programs if you do not use the MicroPython Terminal in XCTU. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
# But the LED we are turning on and off is setup as what is# known as "active low". # This means setting the pin to 0 allows current to flow through the LED and then through the pin, to ground. Digi XBee3 Cellular LTE Cat 1 Smart 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 Smart Modem, and this example provides the building blocks for such a system. This example, based on SMS...
Page 49
(dio0.value() == 0): # Once pressed. print("Button pressed!") # Print message once pressed. break # Exit the WHILE loop. # When you press SW2, you should see "Button pressed!" printed to the Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 50
# message saying "Button pressed" to the given target cell phone number. try: c.sms_send(ph, 'Button Pressed') print("Sent SMS successfully.") except OSError: print("ERROR- failed to send SMS.") # Exit the WHILE loop. break Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 51
= usocket.socket(usocket.AF_INET, usocket.SOCK_DGRAM) # Connect the socket object to the web server specified in "address". addr = ("52.43.121.77", 10002) socketObject.connect(addr) bytessent = socketObject.send("hello") print("Sent %d bytes on socket" % bytessent) Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
1. Open Tera Term. The Tera Term: New connection window appears. 2. Click the Serial radio button to select a serial connection. 3. From the Port: drop-down menu, select the COM port that the XBee Smart Modem is connected to. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 53
Make sure the Local echo box is not checked. 9. Click OK. 10. Press Ctrl+B to get the MicroPython version banner and prompt. Now you can type MicroPython commands at the >>> prompt. Digi XBee3 Cellular LTE Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
Page 56
Technical specifications Interface and hardware specifications RF characteristics Networking specifications Power requirements Power consumption Electrical specifications Regulatory approvals Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Security SSL/TLS Power requirements The following table provides the power requirements for the device. Specification Value Supply voltage range 3.0 to 5.5 VDC Extended voltage range 2.7 to 5.5 VDC Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Min VDD_IO Internal supply While in deep sleep and (VCC- voltage for I/O during initial power up 0.3, 3.3) VDD_IO Internal supply In normal running mode 3.3 V voltage for I/O Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Pin 6 is also 5 V tolerant even when the XBee Smart Modem is not powered. We recommend only driving this pin with 3.3 V for compatibility with other XBee products. The VBUS line is not used to enable/disable USB on this product. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 60
Hardware Mechanical drawings Pin signals RSSI PWM SIM card The Associate LED Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
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 Cat 1 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 Cat 1 Smart Modem User Guide...
½ second The last TCP/UDP/SMS attempt failed. If the LED has this pattern, you may need to check DI (Remote Manager Indicator) (Protocol/Connection Indication) for the cause of the error. Standard single blink 1 second Normal operation. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 64
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 Cat 1 Smart Modem User Guide...
You must connect the primary port and the secondary port is optional. The secondary antenna improves receive performance in certain situations, so we recommend it for best results. FCC-approved antennas for a list of approved antennas. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Bluetooth. Do not mount the surface-mount PCB antenna module on the RF Pad footprint because that footprint requires a ground plane within the keepout area. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
For optimal cellular reception, keep the antenna as far away from metal objects and other electronics (including the XBee Smart Modem) as possible. Often, small antennas are desirable, but come at the cost of reduced range and efficiency. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 69
Design recommendations Cellular component firmware updates USB Direct design Power supply considerations Recommended application circuit Heat considerations and testing Heat sink guidelines Add a fan to provide active cooling Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Inrush current is about 2 A during initial power up of cellular communications and wakeup from sleep mode. 4. Place smaller high frequency ceramic capacitors very close to the XBee Smart Modem VCC pin to decrease high frequency noise. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
If you do not have a way to measure current consumption you can estimate it from the table in the next section. Use those results to approximate the maximum safe ambient temperature for the XBee Smart Modem, T , with the following equation: MAX,amb Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
XBee Smart Modem can be safely operated under that condition. These are provided only as guidelines as your results will vary based on application. We recommend that you perform sufficient Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
P1 (DIO11/PWM1 Configuration) to 1. Note that the I/O pin is not capable of driving a fan directly; you must implement a circuit to power the fan from a suitable power source. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting SMS encoding Digi XBee3 Cellular LTE Cat 1 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 Cat 1 Smart Modem User Guide...
The device converts incoming SMS messages to ASCII. Characters that cannot be represented in ASCII are replaced with a space (' ', or 0x20 in hex). This includes emoji and other special characters. Also referred to as the GSM 7-bit alphabet. Digi XBee3 Cellular LTE Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
Page 81
Sleep modes About sleep modes Normal mode Pin sleep mode Cyclic sleep mode Cyclic sleep with pin wake up mode Connected sleep mode The sleep timer MicroPython sleep behavior Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Connected sleep mode draws 9 mA during sleep and 11 mA average over time (including periodically waking up to maintain connection). Digi XBee3 Cellular LTE Cat 1 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 Cat 1 Smart Modem User Guide...
XBee Smart Modem is fully turned off and no access to the cellular network is performed or possible. Use AM (Airplane Mode) to configure this mode. Digi XBee3 Cellular LTE Cat 1 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 Cat 1 Smart Modem User Guide...
The serial transmit buffer collects the data it receives via the RF link until it transmits that data out the serial or SPI port. Digi XBee3 Cellular LTE Cat 1 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. Digi XBee3 Cellular LTE Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
Page 97
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 Cat 1 Smart Modem User Guide...
TCP port that the device listens on. 4. Click the Write button 1 UDP socket is always reserved for DNS, so subtract 1 socket from the values above. See https://tools.ietf.org/html/rfc793. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
For incoming connections and data in API mode, the XBee Smart Modem uses the C0 (Source Port) IP (IP Protocol) settings to specify the listening port and protocol used. The XBee Smart Modem does not currently support the SSL protocol for incoming connections. Digi XBee3 Cellular LTE Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
Page 102
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 Cat 1 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 Cat 1 Smart Modem User Guide...
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.
Transport Layer Security (TLS) Cipher suites Cipher suites 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 TLS_RSA_WITH_AES_256_CBC_SHA For the Telit LE866 cellular component: TLS_RSA_WITH_RC4_128_MD5...
(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 Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
3. Wait for the cellular component to be initialized: AI (Association Indication) reaches 0x00. 4. Use FR to reset the device a second time. 5. Wait again for the cellular component to initialize: AI reaches 0x00. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Note Due to known vulnerabilities in prior protocol versions, we strongly recommend that you use the latest TLS version whenever possible. Range Value Description 0x00 SSL v3 0x01 TLS v1.0 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
(Transmit (TX) Request: IPv4 - 0x20 Tx Request with TLS Profile - 0x23 with profile set to 0). Format server_cert;client_cert;client_key Parameter range From 1 through 127 ASCII characters. Default Digi XBee3 Cellular LTE Cat 1 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 0- 15 IPv4 characters Default 0.0.0.0 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
To set the destination address to a domain name, the value must be a legal Internet host name, for example remotemanager.digi.com Parameter range 0 - 128 ASCII characters Default 0.0.0.0 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
When you issue the command 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. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Transparent mode is not transmitted until that character is received. To use a carriage return, set to 0xD. Set to zero to disable text delimiter checking. Parameter range 0 - 0xFF Default Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
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). Parameter range 0, 2 - 5 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
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 Description Disabled Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Sets or displays the DIO6/RTS configuration (pin 16). Parameter range 0, 1, 3 - 5 Parameter Description Disabled RTS flow control Digital input Digital output, default low Digital output, default high Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Description Disabled SLEEP_REQUEST input Digital input Digital output, default low Digital output, default high Default Sets or displays the DIO9/ON_SLEEP configuration (pin 13). Parameter range 0, 1, 3 - 5 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Digital input Digital output, low Digital output, high Default P1 (DIO11/PWM1 Configuration) Sets or displays the DIO11 configuration (pin 7). Parameter range 0, 1, 3 - 6 Parameter Description Disabled Digi XBee3 Cellular LTE Cat 1 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 Digi XBee3 Cellular LTE Cat 1 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 I/O sampling commands The following AT commands configure I/O sampling parameters. Digi XBee3 Cellular LTE Cat 1 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 Analog chanel mask 1 byte Samples 2 bytes each Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
CTS disabled for the sleep time interval, then wakes for the wake time interval. Parameter range 0x1 - 0x83D600 (x 10 ms) Default 0x7530 (5 minutes) ST (Wake Time) Sets or displays the time to spend awake in cyclic sleep modes. Digi XBee3 Cellular LTE Cat 1 Smart 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) Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Sets whether or not the XBee Smart Modem runs the stored Python code at startup. Range 0 - 1 Parameter Description Do not run stored Python code at startup. Run stored Python code at startup. Default Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
You can enter Command mode (+++) and send ATPY^ to interrupt the program. Default Firmware version/information commands The following AT commands are firmware version/information commands. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
The cellular component is missing, corrupt, or otherwise in error. The cellular component requires a new firmware image. 0x25 Cellular network registration denied. 0x2A Airplane mode. 0x2B USB Direct active. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
DI (Remote Manager Indicator) 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 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Unknown server - DNS lookup failed. 0x23 Connection lost. 0x24 Unknown. 0xFF No known status. The following table provides the parameter's meaning when IP = 1 or 4 for TCP connections. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 136
0x10 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) Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
FS is a command with sub-commands. These sub-commands are arguments to FS. For FS commands, you have to type AT before the command, for example ATFS PWD, ATFS LS and so forth. Digi XBee3 Cellular LTE Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
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 Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
Page 144
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 Cat 1 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 Cat 1 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 Cat 1 Smart 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 XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Page 150
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 XBee3 Cellular LTE Cat 1 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 Cat 1 Smart Modem User Guide...
Page 152
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 Cat 1 Smart 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 XBee3 Cellular LTE Cat 1 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 Cat 1 Smart Modem User Guide...
Page 155
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 Cat 1 Smart Modem User Guide...
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 Cat 1 Smart Modem User Guide...
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 Cat 1 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.
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 Error Failed to send SMS Digi XBee3 Cellular LTE Cat 1 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 Cat 1 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 Cat 1 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 Cat 1 Smart Modem User Guide...
XBee Smart Modem software. If AI is 0x2F, Bypass mode should work. If not, look at the status codes in AI (Association Indication) for guidance. 2. You can send the !R (Modem Reset) command to reset only the cellular component. Digi XBee3 Cellular LTE Cat 1 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 Cat 1 Smart Modem User Guide...
Regulatory information Modification statement Interference statement FCC Class B digital device notice RF exposure FCC-approved antennas Labeling requirements for the host device Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
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.
If the antenna is mounted at least 25 cm from nearby persons, the application is considered a mobile application. The antennas below have been approved for use with this module. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas.
Contains IC: 1846A-XB3C1 Contains FCC ID:RI7XE866A1NA Contains IC: 5131A-XE866A1NA This Class B digital apparatus complies with Canadian ICES-003. Cet appareil numérique de classe B est conforme à la norme canadienne ICES-003. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide...
Need help?
Do you have a question about the XBee3 Cellular LTE Cat 1 and is the answer not in the manual?
Questions and answers