1. Manuals
  2. Brands
  3. Digi Manuals
  4. Modem
  5. XBee 3 Cat 1
  6. User manual

Digi XBee 3 Cat 1 User Manual

Smart modem
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Digi XBee® 3 Cat 1 Smart Modem
User Guide
Smart Modem
User Guide

Advertisement

Table of Contents
loading

Related Manuals for Digi XBee 3 Cat 1

Summary of Contents for Digi XBee 3 Cat 1

  • Page 1 Digi XBee® 3 Cat 1 Smart Modem User Guide Smart Modem User Guide...
  • Page 2 Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
  • Page 3 Include the document title and part number (Digi XBee® 3 Cat 1 Smart Modem User Guide, 90002503 A) in the subject line of your email. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 4: Table Of Contents

    Contents Digi XBee® 3 Cat 1 Smart Modem User Guide Applicable firmware and hardware SIM cards Safety instructions Safety instructions Инструкции за безопасност Sigurnosne upute Bezpečnostní instrukce Sikkerhedsinstruktioner Veiligheidsinstructies Ohutusjuhised Turvallisuusohjeet Consignes de sécurité Sicherheitshinweise Οδηγίες ασφαλείας Biztonsági utasítások Istruzioni di sicurezza Drošības instrukcijas...
  • Page 5 Create a Remote Manager account Add an XBee Smart Modem to Remote Manager Verify the connection between a device and Remote Manager Configure Remote Manager features using automations Overview: Create an automation Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 6 Update the cellular component firmware using Remote Manager Update the cellular firmware using the API Technical specifications Interface and hardware specifications RF characteristics Networking specifications Bands Power requirements Electrical specifications Regulatory approvals Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 7 Clear all custom configurations on a device SIM cards Cellular connection process Connecting Cellular network Data network connection Data communication with remote servers (TCP/UDP) Disconnecting Modes Select an operating mode Transparent operating mode API operating mode Command mode Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 8 Enable UART or SPI ports SPI operation SPI communications 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 Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 9 Bind local source addres Receive Bind/Listen Response Send to Digi echo server Receive TX Status Receive echoed data Send to Digi time server Receive TX Status Receive daytime value Close the socket Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 10 BM (Bandmask) AM (Airplane Mode) DV (Secondary Antenna Function Switch) SQ (Reference Signal Received Quality) SW (Reference Signal Received Power) PN (SIM PIN) PK (SIM PUK) OT (Operating Technology) FC (Frequency Channel Number) Network commands Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 11 P1 (DIO11/PWM1 Configuration) P2 (DIO12 Configuration) P3 (DIO13/DOUT) P4 (DIO14/DIN) PD (Pull Direction) PR (Pull-up/down Resistor Enable) M0 (PWM0 Duty Cycle) M1 command I/O sampling commands TP (Temperature) IS (Force Sample) Sleep commands Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 12 $S (SRP Salt) $V, $W, $X, $Y (SRP password verifier) Remote Manager commands MO (Remote Manager Options) DF (Remote Manager Status Check Interval) EQ (Remote Manager FQDN) K1 (Remote Manager Server Send Keepalive) Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 13 Example sequence to perform AT Command XBee API frames over BLE BLE Unlock Response - 0xAC Socket Create - 0x40 Socket Create Response - 0xC0 Socket Option Request - 0x41 Socket Option Response - 0xC1 Socket Connect - 0x42 Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 14 %1 (Start test mode) %2 (Stop test mode) %5 (Start modulated transmit) %6 (Stop transmit) %7 (Set EARFCN) %8 (Get the EARFCN) %9 (Set transmit power) %A (Get transmit power) %D (Start receive mode) Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 15 Labeling requirements for the host device: FCC and ISED Regulatory Information Modification statement Interference statement FCC Class B digital device notice RF exposure FCC notices Regulatory Information: ISED Modification statement: ISED Interference statement: ISED RF exposure: ISED Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 16: Digi Xbee® 3 Cat 1 Smart Modem User Guide

    This manual uses the placeholder value "xx" in the firmware versions listed above, as the manual documents the released features as of the time of its writing. Digi International periodically releases new firmware containing bug fixes and new features. As new firmware is released and distributor stock is refreshed, the new firmware will gradually become available without the need to update.

  • Page 17: Sim Cards

    Digi XBee® 3 Cat 1 Smart Modem User Guide SIM cards Description XB3-C-N1-UT-101 XBee 3 North America LTE Cat 1 with AT&T SIM XB3-C-G1-UT-102 XBee 3 Global LTE Cat 1 with Verizon SIM XB3-C-N1-UT-102 XBee 3 North America LTE Cat 1 with Verizon SIM...

  • Page 18: Инструкции За Безопасност

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions Инструкции за безопасност XBee модули Радио модулът XBee не може да бъде гарантиран за работа поради радиовръзката и затова не трябва да се използва за блокировки в критични за безопасността устройства...

  • Page 19: Bezpečnostní Instrukce

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions Krajnjem korisniku se mora reći kako da isključi napajanje iz XBee radio modula ili da locira antene 20 cm od ljudi ili životinja. Bezpečnostní instrukce moduly XBee Rádiový modul XBee nemůže zaručit provoz kvůli rádiovému spojení, a proto by neměl být používán pro blokování...

  • Page 20: Veiligheidsinstructies

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions Udsæt ikke XBee-radiomoduler for vand eller fugt. Brug dette produkt med de antenner, der er specificeret i XBee-modulets brugervejledninger. Slutbrugeren skal fortælles, hvordan man fjerner strømmen fra XBee-radiomodulet eller placerer antennerne 20 cm fra mennesker eller dyr.

  • Page 21: Turvallisuusohjeet

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions töötab väljaspool antud riigi regulatiivseid vastavusi, põhjustades raadio võimaliku ebaseadusliku kasutamise. Kasutage XBee mooduli käsitsemisel tööstusharu standardset ESD-kaitset. Olge käsitsemisel ettevaatlik, et vältida PCB ja komponentide elektrikahjustusi. Ärge jätke XBee raadiomooduleid vee või niiskuse kätte.

  • Page 22: Sicherheitshinweise

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions Il n'y a aucun composant réparable par l'utilisateur à l'intérieur du module radio XBee. Ne retirez pas la protection et ne modifiez en aucune façon le XBee. Les modifications peuvent exclure le module de toute garantie et peuvent entraîner le fonctionnement de la radio XBee...

  • Page 23: Biztonsági Utasítások

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions όπως μηχανήματα ή εφαρμογές αυτοκινήτου. Η μονάδα ραδιοφώνου XBee δεν έχει εγκριθεί για χρήση σε (αυτή η λίστα δεν είναι εξαντλητική): ιατροτεχνολογικά προϊόντα πυρηνικές εφαρμογές εκρηκτικές ή εύφλεκτες ατμόσφαιρες...

  • Page 24: Istruzioni Di Sicurezza

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions Istruzioni di sicurezza Moduli XBee Il funzionamento del modulo radio XBee non può essere garantito a causa del collegamento radio e quindi non deve essere utilizzato per gli interblocchi in dispositivi critici per la sicurezza come macchine o applicazioni automobilistiche.

  • Page 25: Saugos Instrukcijos

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions Saugos instrukcijos XBee moduliai Negalima garantuoti, kad „XBee“ radijo modulis veiks dėl radijo ryšio, todėl jo neturėtų būti naudojamas blokuoti saugai svarbiuose įrenginiuose, pvz., mašinose ar automobiliuose. XBee radijo modulis nebuvo patvirtintas naudoti (šis sąrašas nėra baigtinis): medicinos prietaisai branduolinės programos...

  • Page 26: Instrukcje Bezpieczeństwa

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions Instrukcje bezpieczeństwa Moduły XBee Moduł radiowy XBee nie może zagwarantować działania ze względu na łącze radiowe, dlatego nie należy go używać do blokad w urządzeniach o krytycznym znaczeniu dla bezpieczeństwa, takich jak maszyny lub aplikacje motoryzacyjne.

  • Page 27: Instructiuni De Siguranta

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions O usuário final deve ser informado sobre como remover a energia do módulo de rádio XBee ou localizar as antenas a 20 cm de humanos ou animais. Instructiuni de siguranta module XBee Nu se poate garanta funcționarea modulului radio XBee din cauza conexiunii radio și, prin...

  • Page 28: Varnostna Navodila

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions Pri manipulácii buďte opatrní, aby ste predišli elektrickému poškodeniu dosky plošných spojov a komponentov. Rádiové moduly XBee nevystavujte vode ani vlhkosti. Tento produkt používajte s anténami špecifikovanými v používateľských príručkách modulu XBee.

  • Page 29: Säkerhets Instruktioner

    Digi XBee® 3 Cat 1 Smart Modem User Guide Safety instructions de cualquier garantía y pueden hacer que la radio XBee funcione fuera del cumplimiento normativo de un país determinado, lo que puede provocar una operación ilegal de la radio.

  • Page 30: Get Started With The Xbee Smart Modem

    2. Review introductory MicroPython examples. You can use MicroPython to enhance the intelligence of the XBee to enable you to do edge-computing by adding business logic in MicroPython, rather than using external components. Example: hello world Example: turn on an LED Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 31: Identify The Kit Contents

    This cable will not power the development board. One XBee Smart Modem Note When purchased as a kit, the XBee Smart Modem comes pre-installed in the XBIB-U-C in an ESD-safe bag. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 32: Determine Cellular Service And Acquire A Sim Card

    SIM card in the US and Europe. US customers In the US, Digi XBee® 3 LTE Cat 1 Smart Modem works with AT&T and Verizon (pending carrier approval). You must purchase a SIM card before you can connect the hardware. Contact Digi Sales at www.digi.com/contactus...

  • Page 33: Connect The Hardware

    Align the U.FL connectors carefully, then firmly press straight down to seat the connector. You should hear or feel a click when the antenna attaches correctly. Caution should be used when connecting or removing the U.FL. Digi recommends using a U.FL removal tool. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 34: Install And Upgrade Xctu

    Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices. XCTU does not work directly over an SPI interface.

  • Page 35: Update The Device And Cellular Firmware Using Xctu

    LED is blinking. If it reads 23 it is connecting to the Internet; 22 means it is registering to the cellular network. MY (Module IP Address) should display a valid IP address. If it reads 0.0.0.0, it has not registered yet. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 36: Cellular Service

    To read a command's value, click the Read button next to the command. Cellular service Digi now offers Cellular Bundled Service plans, where you can choose to purchase a subscription for cell service, and/or a Digi Remote Manager package. To shop online, go to: shop.digi.com...
  • Page 37 Connect to the Echo server Connect to the ELIZA server Connect to the Daytime server Send an SMS message to a phone Perform a (GET) HTTP request Connect to a TCP/IP address Software libraries Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 38: Xbee Connection Examples

    For instructions on using the Console, see the AT console topic in the XCTU User Guide. 10. Click the Open button to open a serial connection to the device. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 39: Connect To The Eliza Server

    6. To enter the destination address of the ELIZA Therapist Bot, in the DL field, type 52.43.121.77 and click the Write button. 7. To enter the destination IP port number, in the DE field, type 2328 and click the Write button. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 40: Connect To The Daytime Server

    Set the expected transmission mode to TCP communications. Protocol) 52.43.121.77 The target IP of the Daytime server. (Destination Address) 232A (0x232A) The target port number of the Daytime server. (Destination Port) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 41: Send An Sms Message To A Phone

    The XBee Smart Modem can send and receive Short Message Service (SMS) transmissions (text messages) while in Transparent mode. This allows you to send and receive text messages to and from Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 42 11. Click in the left pane of the Console log, type hello world and press Enter. The XBee Smart Modem sends the message to the destination phone number set by the P# command. Note If you are receiving individual characters, verify that you set TD correctly. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 43: Perform A (Get) Http Request

    14. Click the HEX input tab and add 0A (zero A) after each 0D (zero D), and add an additional 0D 0A at the end of the message body. For example, copy and past the following text into the HEX input tab: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 44: Connect To A Tcp/Ip Address

    5. In the IP field, select 1 and click the Write button 6. In the DL field, type the <target IP address> and click the Write button. The target IP address is the IP address that you send and receive from. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 45: Software Libraries

    The XBee Python Library is a Python API that dramatically reduces the time to market of XBee projects developed in Python and facilitates the development of these types of applications, making it an easy process. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 46 Use the MicroPython Terminal in XCTU Example: hello world Example: Turn on an LED Example: Code a request help button Example: Debug the secondary UART Exit MicroPython mode Other terminal programs Use picocom in Linux Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 47: Get Started With Micropython

    5. Note what COM port(s) the XBee Smart Modem is using, because you will need this information when you use terminal communication. The Radio Modules information panel lists the COM port in use. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 48: Use The Micropython Terminal In Xctu

    This example is only for kits that use the XBIB-CU-TH development board. For an example that uses the XBIB-U-DEV development board, see Example: Turn on an LED. Other terminal programs if you do not use the MicroPython Terminal in XCTU. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 49: Example: Code A Request Help Button

    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 50: Enter Micropython Paste Mode

    For this part of the example, you write code that responds to a button press on the XBIB-CU-TH-DEV board that comes with the XBee Smart Modem Development Kit. The code monitors the pin connected to the button on the board labeled Comm. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 51 PDF version, as it may not maintain essential indentations. Note If you have problems pasting the code, see Syntax error at line 1. For SMS failures, see Error Failed to send SMS. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 52: Send A Text (Sms) When The Button Is Pressed

    PDF version, as it may not maintain essential indentations. Note If you have problems pasting the code, see Syntax error at line 1. For SMS failures, see Error Failed to send SMS. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 53: Add The Time The Button Was Pressed

    # Send message to the given number. Handle error if it occurs. try: c.sms_send(ph, 'Button Pressed at: ' + str(buf)) print("Sent SMS successfully.") except OSError: print("ERROR- failed to send SMS.") # Exit the WHILE loop. break Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 54: Example: Debug The Secondary Uart

    3. In XCTU's Configuration working mode , change AP API Enable to another mode and click the Write button . We recommend changing to Transparent mode [0], as most of the examples use this mode. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 55: Other Terminal Programs

    7. Click OK to apply the changes to the serial port settings. The settings should go into effect right away. 8. To verify that local echo is not enabled and that extra line-feeds are not enabled: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 56: Use Picocom In Linux

    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 XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 57 Get started with MicroPython Use picocom in Linux Now you can type MicroPython commands at the >>> prompt. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 58: Get Started With Bluetooth® Low Energy

    BLE (Bluetooth® Low Energy) is an RF protocol that enables you to connect your XBee (server) device to another (client) device. he latest Digi XBee products include a dual-mode radio that allows the device to communicate through the BLE interface and the RF/Cellular network at the same time.

  • Page 59: Enable Ble And Configure The Ble Password Using Xctu

    Before you begin, you should determine the password you want to use for BLE on the XBee device and store it in a secure place. Digi recommends a secure password of at least 8 characters and a random combination of letters, numbers, and special characters. Digi also recommends using a security management tool such as Bitwarden or Keepass for generating and storing passwords for many devices.

  • Page 60: Get The Digi Xbee Mobile Phone Application

    8. Click OK to save the configuration. Get the Digi XBee Mobile phone application To see the nearby devices that have BLE enabled, you must get the free Digi XBee Mobile application from the iOS App Store or Google Play and downloaded to your phone.

  • Page 61: Api Request Characteristic

    Response data will be presented through indications on this characteristic. Indications are acknowledged and re-transmitted at the BLE link layer and application layer and provides a robust transport for this data. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 62: Get Started With Digi Remote Manager

    Get started with Digi Remote Manager Digi Remote Manager® is a cloud-based device and data management platform that you can use to configure and update a device, and view and manage device data. The sections below describe how to create a Remote Manager account, upgrading your device, configure your device, and manage data in Remote Manager.

  • Page 63: Create A Remote Manager Account

    Create a Remote Manager account and add devices Create a Remote Manager account Digi Remote Manager is an on-demand service with no infrastructure requirements. Remote devices and enterprise business applications connect to Remote Manager through standards-based web services. This section describes how to configure and manage an XBee using Remote Manager. For...

  • Page 64: Configure Remote Manager Features Using Automations

    The following provides a template of how to create a schedule for an XBee to connect, perform a set of tasks and then disconnect: 1. Make sure that SM/UDP is enabled. See Enable SM/UDP. Log into Remote Manager. 3. Click Automations. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 65: Automation Examples

    Click Confirm to start the automation. Automation examples The examples in the following sections assume you are using the Digi Remote Manager Automations wizard. However, you should be aware that operations can be created and performed programmatically via web service calls or via the API explorer. The XML web service calls provide more options than are available in the GUI dashboard for some tasks.

  • Page 66: Example: Configure A Device From Remote Manager Using Xml

    In this configuration example, you are changing the device to poll four times a day instead of just once. In this case, you should change the DF parameter to 360 minutes. Log into Remote Manager. 2. Click Automations. 3. Click Create to launch the wizard. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 67: Example: Schedule An Automation To Update The Device Firmware Using Remote Manager

    .gbl file for the new firmware from our support site. This file is one of the files in the .zip (for example, XBXC-31011.zip) archive that you can download for the product. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 68 Click on the run you are interested in to display a details for each device. e. For the device you are interested in, click the Status link under the Summary column to see more details and the responses. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 69: Example: Update Micropython From Remote Manager Using An Automation

    In the Destination File Path field, enter: ~/MicroPython/uftp.py iii. Enable Allow Offline. iv. From the On Error list box, select Continue. g. Click + again to add another step, and select RCI. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 70: Manage Data In Remote Manager

    Remote Manager. The device must be in the Remote Manager inventory device list and be active. 1. Set up a persistent connection to connect the device to Remote Manager using one of the following methods: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 71: Manage Secure Files In Remote Manager

    3. Select the device for which you want to manage files. 4. Click Files to open file management view. From this view you can add or remove files on your device. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 72: Remote Manager Reference

    You can use the SM/UDP feature to leverage the very small data footprint of Remote Manager SM protocol over UDP. Note Battery Operated Mode may be enabled in Digi Remote Manager. Review the Battery Operated Mode section to determine the impact of enabling this mode on SM/UDP.

  • Page 73: Determine The Location Of The Firmware Version

    Determine the location of the firmware version You must first determine the location of the firmware version to which you want to update. Digi provides updates by hosting them on an FTP server: ftp1.digi.com. If the FTP location is not accessible to your XBee Cellular, such as if you are using a VPN, the files may be retrieved and hosted separately on a server that it can reach.

  • Page 74: Configure Xbee Settings Within Remote Manager

    XBee Cellular variant to determine the necessary upgrade path for your product. You will need: The FTP hostname or IP address, which for Digi hosted files is: ftp1.digi.com The port running the FTP server, which is typically 21 Username. For ftp1.digi.com, use: anonymous Password.
  • Page 75 Request connect feature in Remote Manager. Digi Remote Manager is enabled on the XBee by default and has a 60 second keepalive interval, which can result in excessive cellular data usage, depending on your plan. The commands can be used to tune the keepalive interval. Your carrier will disconnect an inactive socket automatically if there is no activity, so you need to tune this value based on your carrier’s disconnect timeout.

  • Page 76: Device Requests In Remote Manager

    For best results, you should notify others that you plan to reformat the XBee's filesystem before you initiate a format device request. When you initiate a format device request, the following occurs: Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 77 MicroPython application. The contents of the filesystem are reset to their initial default state.  Example: <sci_request version="1.0"> <data_service> <targets> <device id="Your Device ID here" /> </targets> <requests> <device_request target_name="format"/> </requests> </data_service> </sci_request> Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 78: Examples: Iot Protocols With Transparent Mode

    The following examples provide some additional scenarios you can use to get familiar with the XBee. If you are interested in using the intelligence built into the XBee, see Get started with MicroPython. Get started with CoAP Get started with MQTT Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 79: Get Started With Coap

    1 1 1 1 1 1 1 1 Payload (if any) ... This is an example GET request: 44 01 C4 09 74 65 73 74 B7 65 78 61 6D 70 6C 65 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 80: Configure The Device

    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 XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 81: Example: Use Python To Generate A Coap Message

    HTTP protocol and how to do this using the XBee Smart Modem. In this example, the XBee Smart Modem talks to a CoAP Digi Server. You can use this client code to provide an abstract wrapper to generate a CoAP message that commands the XBee Smart Modem to talk to the remote CoAP server.
  • Page 82 In the following figure, the payload contains the server response to the query. It shows the results for when you press Enter rather than Y. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 83: Get Started With Mqtt

    Description Hex value CONNECT packet fixed header byte 1 Control packet type 0x10 byte 2 Remaining length 0x10 CONNECT packet variable header Protocol name byte 1 Length MSB (0) 0x00 Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 84 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® 3 Cat 1 Smart Modem User Guide...

  • Page 85: Send A Connect Packet

    The length of the ID (in bytes) precedes the ID itself. Each client connecting to a broker must have a unique client ID. In the example, the ID is DIGI. When using the Paho MQTT Python libraries, a random alphanumeric ID is generated if you do not specify an ID.

  • Page 86: Example: Send Messages (Publish) With Mqtt

    A basic Python example of a node publishing (sending) a message is: mqttc = mqtt.Client("digitest") # Create instance of client with client ID “digitest” mqttc.connect("m2m.eclipse.org", 1883) # Connect to (broker, port, keepalive-time) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 87: Example: Receive Messages (Subscribe) With Mqtt

    # Define callback function for successful connection client.on_message = on_message # Define callback function for receipt of a message # client.connect("m2m.eclipse.org", 1883, 60) # Connect to (broker, port, keepalive-time) client.connect('127.0.0.1', 17300) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 88: Use Mqtt Over The Xbee Cellular Modem With A Pc

    4. You can make the proxy with a dual-threaded Python script, a simple version follows: import threading import serial import socket def setup(): """ This function sets up the variables needed, including the serial port, and it's speed/port settings, listening socket, and localhost adddress. """ Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 89 - socket has closed. Exiting socket reader thread.") return 1 # Exit the thread to avoid a loop of 0-byte receptions else: print("Received {} bytes from client via socket.".format(len (data))) Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 90 MQTT client to use the data connection provided by the device. Think of the proxy script as a translator between the MQTT client and the XBee Smart Modem. The following figure shows the basic operation. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 91 To avoid these errors, it is best to start the scripts in the correct order: proxy, then subscribe, then publish. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 92: Update The Firmware

    You should update your XBee to the latest firmware to take advantage of all the latest fixes and features. Refer to the topics below for information about the available update methods. Digi strongly recommends that you devise a plan to update the firmware after initial deployment. For more information, see Create a plan for device and cellular component firmware updates.
  • Page 93 Update the firmware Create a plan for device and cellular component firmware updates If the XBee firmware is updated over-the-air using Digi Remote Manager: After the new firmware image has been downloaded and validated, the XBee modem reboots automatically to install the firmware. The XBee then resets into the new firmware once the update is complete, which may take up to 60 seconds.

  • Page 94: Update The Device And The Cellular Firmware Using Xctu

    The device is added to XCTU. See Add a device to XCTU. Digi XBIB-CU-TH development board, or your own hardware which enables USB Direct access USB cable for USB Direct access is connected to the PC Cellular component USB drivers are installed To update the device and cellular firmware: 1.
  • Page 95 XCTU applies and updates the device firmware. If the cellular firmware is being updated, XCTU reconfigures the XBee for USB Direct access and updates the new cellular firmware on the device. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 96: Update The Device Firmware

    Go to the Digi XBee 3 NA/Global LTE Cat 1 support page. b. Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 NA/Global LTE Cat 1 firmware release to download the zip file. d. Unzip the file. The file contains either a .ebin or a .gbl file.

  • Page 97: Update The Firmware Using Web Services In Remote Manager

    Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 Global LTE Cat 1 firmware release to download the zip file. d. Unzip the file and locate the .gbl file in the unzipped directory. 2. Send an HTTP SCI request to Remote Manager with the contents of the downloaded .gbl file converted to base64 data.
  • Page 98 # Remote Manager device ID of the device being updated device_id = '00010000-00000000-03526130-70153378' # Remote Manager username and password username = "my_remote_manager_username" password = "my_remote_manager_password" url = 'https://remotemanager.digi.com/ws/sci' # Form update_firmware request Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 99: Use A Host Processor To Update The Device Firmware For Xbee 3 Devices Over Uart

    After the command is sent, the radio module resets and automatically enters programming mode. 3. Once the device is in programming (bootloader) mode, configure the local serial port to 115200/8/N/1. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 100: Update The Cellular Firmware

    At this time cellular component firmware updates are not available for this device, as there is only one firmware version available. This section is provided as a reference so you can review and plan your update strategy. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 101 Determine the location of the firmware version You must first determine the location of the firmware version to which you want to update. Digi provides updates by hosting them on an HTTP server: ftp1.digi.com. If the HTTP location is not accessible to your XBee Cellular, such as if you are using a VPN, the files may be retrieved and hosted separately on a server that it can reach.

  • Page 102: Update The Cellular Firmware Using The Api

    After the update has been triggered, it may take up to 30 minutes for the update to be applied and for the module to be connected to the network once more. If the XBee is not configured to automatically connect to Digi Remote Manager, you will need to reconnect to Remote Manager to perform validation.
  • Page 103 Important notes Consider the following before performing a cellular component firmware update. Note Digi recommends that you perform a cellular firmware update using XCTU. CAUTION! Avoid interrupting the process if possible. An interruption requires starting over. If the interruption occurs while the bootloader is being updated (part number 82004156) the device may not be recoverable.
  • Page 104 If the host sets bit 2 of the flags byte in FW Update - 0x2B, the update in progress is aborted. Recovery is then equivalent to the recovery for negative acknowledgments, described above. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 105 Update the cellular firmware 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® 3 Cat 1 Smart Modem User Guide...

  • Page 106: Technical Specifications

    GSM (2G) (Global module only): GMSK and 8-PSK Transmit power 23 dBm 7 dBm Receive sensitivity -102 dBm -92 dBm Over-the-air maximum data 10 Mb/s (downlink), 5 Mb/s (uplink) 2 Mb/s rate Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 107: Networking Specifications

    B8 (900 MHz) B19 (850 MHz) PLSx3-W PLSx3-X World North America LTE-FDD B1 (2100 MHz) B2 (1900 MHz) B3 (1800 MHz) B4 (2100 MHz) B5 (850 MHz) B7 (2600 MHz) B8 (900 MHz) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 108: Power Requirements

    Supply voltage range 3.0 to 5.5 VDC 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 Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 109 Pin 6 is also 5 V tolerant even when the XBee Smart Modem is not powered. We recommend only driving this pin with 3.3 V for compatibility with other XBee products. The VBUS line is not used to enable/disable USB on this product. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 110: Regulatory Approvals

    QIPPLS63-X QIPPLS63-W Model: XB3C2 Model: XB3C2 IC: 1846A-XB3C2 IC: 1846A-XB3C2 Innovation, Science and Economic Development Contains IC: 7830A- Contains IC: 7830A- Canada (ISED) PLS63-X PLS63-W Model: XB3C2 Model: XB3C2 Europe (CE) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 111: Hardware

    The following figures show the mechanical drawings for the XBee Smart Modem. All dimensions are in inches. For XBee header information, see XBee header connector requirements. Pin signals The pin locations are: Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 112 (output) CONFIG_ (input) (input) DIO12 SPI_MISO (input) (output) RESET_ (input) RSSI PWM0 DIO10 USB_VBUS (output) (output) USB D+ PWM1 DIO11 C_SDA (output) (i/o) USB D- SLEEP_RQ_ DTR_ DIO8 (input) (input) (power) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 113: Pin Connection Recommendations

    The recommended minimum pin connections are VCC, GND, DIN, DOUT, RTS, DTR and RESET. Firmware updates require access to these pins. XBee header connector requirements The XBee header connectors require the following attributes: female 2 mm pitch Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 114: Rssi Pwm

    In firmware version *1A and newer, sleep is allowed when raw NMEA is enabled; GNSS will be temporarily stopped for sleep, then re-enabled on wake. Sleep is held off when a one-shot/single location acquisition is active. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 115: Associate Led Functionality

    Where the low signal means LED off and the high signal means LED on. When CI is not 0 or 0xFF, the Associate LED has a different blink pattern that looks like this: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 116: Development Boards

    XBIB-CU-TH reference This picture shows the XBIB-CU-TH development board and the table that follows explains the callouts in the picture. Note This module is sold separately or in our XBee3 Cellular Kits. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 117 When in the ACTIVE position, power must be delivered via jumper P10. This allows current measurements to be conducted by attaching a current meter across the jumper P10. Note The USB-to-serial communications connection may affect this current measurement. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 118 Connecting to a USB 2.0 port will result in unreliable operation. LED indicator Red: UART DOUT (modem sending serial/UART data to host) Green: UART DIN (modem receiving serial/UART data from host) White: ON/SLP/DIO9 Blue: Connection Status/DIO5 Yellow: RSSI/PWM0/DIO10 Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 119 USB direct mode: Both switches must be in the left position. For more information, see Connect the hardware for USB Direct mode. C sensor: Both switches must be in the right position. See item 10, Temp/Humidity Sensor. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 120: Antenna Recommendations

    Do not make a dual footprint of the XBee Cellular TH Integral Antenna and the surface-mount PCB antenna module RF Pad footprint, as the RF Pad footprint requires a ground plane within the keepout area of the integral antenna. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 121 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 122: Through-Hole Keepout

    Antenna recommendations Keepout area and design recommendations Through-hole keepout Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 123: Antenna Placement

    When the GNSS antenna is placed close to the module, a 15 dB gain is enough. In the case of a long cable, the gain has to be increased up to 30 dB. An active GNSS antenna is required in most applications. The active antenna should meet the following specifications: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 124: Gnss Receiver Characteristics

    Further care in antenna placement must be taken when operating on LTE Band 13 to avoid loss of GNSS sensitivity. The antenna must not be installed inside metal cases or near any obstacle that may degrade performance. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 125: Design Recommendations

    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 XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 126: Add A Fan To Provide Active Cooling

    Clean shutdown Digi strongly recommends performing a clean shutdown procedure on your XBee cellular devices before removing power from the devices. Performing a shutdown allows the module to unregister from the cellular network and safely store operating parameters. Failure to shutdown properly has the potential to result in delays resuming network operation and in some rare instances may result in an unrecoverable module failure.

  • Page 127: Cellular Component Firmware Updates

    If pin 7 is used in the application, it must be disconnected to perform the USB Direct firmware update. Recommended application circuit In all cases, but especially in high EMI (electromagnetic interference) noise environments, Digi recommends adding a 10 nF ceramic capacitor very close to pin 5.

  • Page 128: Set A Custom Configuration

    The specific failure mode is fretting between the contacts of the SIM card and the card holder. For highest reliability, Digi strongly recommends that you apply a thin layer of dielectric grease to the SIM contacts prior to installing the SIM card. You need only to apply enough dielectric grease that the mating area of the contacts is protected from exposure to air and humidity.

  • Page 129: Cellular Connection Process

    Cellular connection process Connecting Data communication with remote servers (TCP/UDP) Disconnecting Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 130: Connecting

    1. The server closes the connection. 2. The TM timeout expires (see TM (IP Client Connection Timeout)). 3. The cellular network may also close the connection after a timeout set by the network operator. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 131: Disconnecting

    2. The cellular connection is shut down. 3. The cellular component is powered off. Note We recommend performing a safe shutdown before resetting or rebooting the device to allow the cellular module to detach from the network. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 132: Modes

    Modes Select an operating mode Transparent operating mode API operating mode Command mode MicroPython mode USB direct mode Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 133: Select An Operating Mode

    Bypass operating mode. The default mode is Transparent operating mode. Use the AP (API Enable) command to select a different operating mode. The following flowchart illustrates how the modes relate to each other. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 134: Transparent Operating Mode

    When the device is in Command mode, it listens for user input and is able to receive AT commands on the UART. If CT time (default is 10 seconds) passes without any user input, the device drops out of Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 135: Troubleshooting

    Response to AT commands When using AT commands to set parameters the XBee Smart Modem responds with OK<cr> if successful and ERROR<cr> if not. For devices with a file system: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 136: Apply Command Changes

    REPL or code launched at startup. When code runs in MicroPython with AP set to a value other than 4, stdout is discarded and there is no input to read on stdin. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 137: Usb Direct Mode

    USB direct mode USB direct mode Note In order to use USB direct mode in Digi XBee development kits, you must use the XBIB-C-TH development board. Note You should use this mode if you want to connect using PPP through the cellular modem while using a host operating system, such as embedded Linux.

  • Page 138: Configure And Use Ppp With An Xbee 3 Modem

    PPPD by default looks in the /etc/ppp/ directory for an options file and a chat script. The option file configures and specifies the chat script for PPPD. The chat script configures and dials the modem for the PPP connection. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 139 In the net-chat script below, you must replace <APN> with the correct APN for your network and SIM. ABORT 'ERROR' ABORT 'BUSY' ABORT 'NO CARRIER' '' AT OK AT+IFC=2,2 OK ATE0 OK AT+CGDCONT=1,"IP","<APN>" OK AT&S0 Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 140 +CME ERRORScript /usr/sbin/chat -V -t 60 -f net-chat finished (pid 5523), status = 0x4 Connect script failed This indicates that the <APN> field was most likely not set correctly in the net-chat script. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 141 /dev/ directory as ppp_direct_usb. Error after running "ping www.digi.com" ping: unknown host www.digi.com The name server was not setup correctly for the PPP interface. Make sure there is a valid name server in /etc/resolv.conf. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 142: Sleep Modes

    Sleep modes About sleep modes Normal mode Pin sleep mode Cyclic sleep mode Cyclic sleep with pin wake up mode Sleep timer MicroPython sleep behavior Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 143: About Sleep Modes

    Upon entering deep sleep mode, the XBee Smart Modem closes any active UDP connections and turns off the cellular component. As a result, any sockets that were opened in MicroPython prior to sleep Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 144 (b'', (<address from connect()>, <port from connect()>) ) The underlying UDP socket resources have been released at this point. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 145: Power Saving Features And Design Recommendations

    Power saving features and design recommendations Airplane mode Low voltage shutdown Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 146: Airplane Mode

    When in the shutdown state, the XBee VCC voltage must rise 100 mV (set by AT%M) above the shutdown voltage (AT%L) to reset and then resume normal operation. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 147 Power saving features and design recommendations Low voltage shutdown Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 148: Serial Communication

    9600 baud and it brings the device up in Command mode on the UART port. You can then send the appropriate commands to the device to configure it for UART operation. If those parameters are written, the device comes up with the UART enabled on the next reset. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 149: Uart Data Flow

    SPI port, enable SPI_MISO (P2), SPI_MOSI (D4), SPI_SSEL (D3), and SPI_CLK (D2) as peripherals. If you enable both ports then output goes to the UART until the first input on SPI. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 150 If both ports are disabled on reset, the device uses the UART in spite of the wrong configuration so that at least one serial port is operational. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 151: Spi Operation

    Frame Format mode 0 is used. This means CPOL= 0 (idle clock is low) and CPHA = 0 (data is sampled on the clock’s leading edge). The SPI port only supports API Mode (AP = 1). The following diagram shows the frame format mode 0 for SPI communications. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 152: Full Duplex Operation

    During the time that the SPI master is sending invalid data to the SPI slave, it is important no 0x7E is included in that invalid data because that would trigger the SPI slave to start receiving another valid frame. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 153: Low Power Operation

    By default, Digi configures DIO8 (SLEEP_REQUEST) as a peripheral and during pin sleep it wakes the device and puts it to sleep. This applies to both the UART and SPI serial interfaces.

  • Page 154: Force Uart Operation

    The XBee Smart Modem sends 0xFF when there is no data to send to the host. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 155: File System

    The directory . refers to the current directory, so the command ATFS ls . lists files in the current directory. Names are case-insensitive, so FILE.TXT, file.txt and FiLe.TxT all refer to the same file. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 156: Secure Files

    SHA256 hash of the file contents. In this way you can validate that the correct file has been placed on the XBee Smart Modem. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 157: Sms Behaviors

    The device converts incoming SMS messages to ASCII. Characters that cannot be represented in ASCII are replaced with a space (' ', or 0x20 in hex). This includes emoji and other special characters. Also referred to as the GSM 7-bit alphabet. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 158 API mode behavior for incoming UDP data Transparent mode behavior for outgoing TCP and TLS connections Transparent mode behavior for outgoing UDP data Transparent mode behavior for incoming TCP connections Transparent mode behavior for incoming UDP connections Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 159: Socket Behavior

    Timeout)) or when the socket is closed via a TX request with the CLOSE flag set. 1 UDP socket is always reserved for DNS, so subtract 1 socket from the values above. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 160: Udp Datagram Size Limits

    Transmit (TX) Status - 0x89 frame in reply to the Transmit TX Request indicating the status of the request. A status of 0 indicates the connection and/or data was successful, a value of Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 161: Api Mode Behavior For Outgoing Udp Data

    To send data from the device over the connection, use the Transmit (TX) Request: IPv4 - 0x20 frame with the corresponding address fields received from the Receive RX frame. In other words: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 162: Api Mode Behavior For Incoming Udp Data

    The first send opens up a UDP socket used to send and receive data. Any data received by this socket is sent out the XBee Smart Modem's serial port. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 163: Transparent Mode Behavior For Incoming Tcp Connections

    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 XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 164: Extended Socket Frames

    Paste the provided frame content directly into the Add API frame to list window in XCTU to follow along manually. Extended Socket example: Single HTTP Connection Extended Socket example: UDP Extended Socket example: TCP Listener Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 165: Available Extended Socket Frames

    This example demonstrates a complete request with an HTTP server. It fetches a random fact about a number from a web services API offered by the website http://numbersapi.com. Note Digi is not affiliated with numbersapi.com and the example is for education only. Send a Socket Create frame Note...

  • Page 166: Receive A Socket Create Response

    The request to connect is immediately acknowledged with a response. However, it is not permitted to proceed transmitting data until the next stage, after a Socket Status frame has been received indicating success. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 167: Receive A Socket Status

    This allows the example to demonstrate the Socket Status reporting of a close by the peer. Field Value 0x44 (Socket Status) Frame type Frame ID 0x01 Socket ID 0x00 Transmit Options 0x00 GET /random/trivia HTTP/1.1 Data Host: numbersapi.com Connection: close Socket Send frame data: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 168: Receive Tx Status

    Access-Control-Allow-Headers: X-Requested-With X-Numbers-API-Number: 270 X-Numbers-API-Type: trivia Pragma: no-cache Cache-Control: no-cache Expires: 0 270 is the average number of days in human pregnancy. Receive Data received from XBee containing web service response: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 169: Receive Socket Status Indicating Closed Connection

    Send a Socket Create frame Field Value 0x40 (Socket Create) Frame type Frame ID 0x01 Protocol 0x00 (UDP) UDP Socket Create frame data: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 170: Receive A Socket Create Response

    The XBee generates a response indicating the status of the request to bind the requested port. Field Value 0xC6 (Socket Bind/Listen Response) Frame type Frame ID 0x01 Socket ID 0x00 Status 0x00 (Success) Socket Bind/Listen Response received from XBee: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 171: Send To Digi Echo Server

    Extended Socket frames Extended Socket example: UDP 7E 00 04 C6 01 00 00 38 Send to Digi echo server Digi hosts a server at 52.43.121.77 port 10001 which echos all UDP traffic sent to it. Field Value 0x45 (Socket SendTo)

  • Page 172: Send To Digi Time Server

    7E 00 13 CE 00 00 34 2B 79 4D 27 11 00 65 63 68 6F 20 74 68 69 73 5D Send to Digi time server Digi hosts a server at 54.43.121.77 port 10002 which will reply with the time when it receives a packet.

  • Page 173: Close The Socket

    Finally, the XBee indicates the socket has been closed with a Socket Close Response frame. Field Value 0xC3 (Socket CloseResponse) Frame type Frame ID 0x01 Socket ID 0x00 Status 0x00 (Success) Socket Close Response received from XBee: 7E 00 04 C3 01 00 00 3B Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 174: Extended Socket Example: Tcp Listener

    The Socket Bind/Listen Frame takes the socket ID from the socket create response and a source port that the socket will then listen on. In this example port 10001 is used. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 175: Receive A Socket Bind/Listen Response

    It contains the listener's socket ID and the new Client Socket ID along with the connection's remote address information. Field Value 0xCC (Socket New IPv4 Client) Frame type Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 176: Receiving Data From The New Socket

    You may close the client socket remotely which elicits a Socket Status with a Status of 0x07. Field Value 0xCF (Socket Status) Frame type Socket ID 0x01 Status 0x07 (Connection lost) Socket Status received from XBee indicating connection lost: 7E 00 03 CF 01 07 28 Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 177 When a Socket Status indicating a connection close is received, the socket ID will have been de- allocated by the XBee and no further operations are possible or necessary using that ID. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 178: Transport Layer Security (Tls)

    Specifying TLS keys and certificates Transparent mode and TLS API mode and TLS Key formats Certificate limitations Cipher suites Secure the connection between an XBee and Remote Manager with server authentication Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 179: Specifying Tls Keys And Certificates

    2. Server authentication: Only ca_cert is provided. Only the servers identity is checked 3. Mutual authentication: All items are provided and both sides are assured of the identity of their peer It is not possible to only have client authentication. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 180: Transparent Mode And Tls

    The RSA PKCS#1 format is the only common format across XBee Cellular device variants. You can identify a PKCS#1 key file by the presence of BEGIN RSA PRIVATE KEY in the file header. Digi's implementation does not support encrypted keys, we use file system encryption to protect the keys at rest in the system.
  • Page 181 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA) TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_ECDH_RSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDH_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_128_CCM TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 TLS_RSA_WITH_AES_128_CCM_8 TLS_RSA_WITH_AES_256_CCM_8 TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 TLS_DHE_RSA_WITH_AES_256_CBC_SHA Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 182: Secure The Connection Between An Xbee And Remote Manager With Server Authentication

    1. Verify the following settings: Setting Value Bit 0 (mask 0x1) must be set. This enables the use of Digi Remote Manager within the firmware. Bit 1 (mask 0x2) must be set. When this value is set the Remote Manager TCP connection will be secured with TLS.

  • Page 183: Step 3: Verify That Authentication Is Being Performed

    6 to verify that the server was correctly authenticated. 0: Connected without TLS 5: Connected with TLS but without authentication 6: Connected with TLS and with authentication Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 184: At Commands

    Sleep commands Command mode options MicroPython commands Firmware version/information commands Diagnostic interface commands Execution commands File system commands BLE commands Remote Manager commands System commands Socket commands GNSS commands Power measurement commands Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 185: Special Commands

    If you issue FR while the device is in Command Mode, the reset effectively exits Command mode. Note Digi recommends shutting down the cellular component before resetting or rebooting the device to allow the cellular module to detach from the network. The cellular component can be shut down by issuing the command.

  • Page 186: Sd (Shutdown)

    Reads the SIM card phone number. If PH is blank, the XBee Smart Modem is not registered to the network. Parameter range Default Set by the cellular carrier via the SIM card Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 187: S# (Iccid)

    Reads the network operator on which the device is registered. Parameter range MV (Modem Firmware Version) Read the firmware version string for cellular component communications. See the related (Firmware Version) command. Parameter range Default Set in the currently loaded firmware Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 188: Mu (Modem Firmware Revision Number)

    The time is provided by the network. If the time is not what you expect, contact your network provider. Parameter range 0 - 1 Value Description The response is the number of seconds since 2000-01-01 00:00:00, as a 32- bit number. This is the default. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 189: An (Access Point Name)

    BM (Bandmask) command. 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 XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 190: Bm (Bandmask)

    AM (Airplane Mode) When set, the cellular component of the XBee Smart Modem is fully turned off and no access to the cellular network is performed or possible. Parameter range 0 - 1 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 191: Dv (Secondary Antenna Function Switch)

    RSRQ = -(0xA0 / 0xA) = -16.0 dB If the value cannot be retrieved for some reason, such as the device is not on the network yet, an empty string with OK after it is returned. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 192: Sw (Reference Signal Received Power)

    8 ASCII digits or space character A value of a single space character (ASCII 0x20) acts as an empty value. Default 0x20: A single ASCII space that indicates there is no PUK. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 193: Ot (Operating Technology)

    The following commands are network commands. IP (IP Protocol) Sets or displays the IP protocol used for client and server socket connections in IP socket mode. Parameter range 0 - 4 Value Description 0x00 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 194: Tl (Tls Protocol Version)

    From 1 through 127 ASCII characters. Default $1 (TLS Profile 1) Specifies the TLS certificate(s) to use for Tx Request with TLS Profile - 0x23 transmissions with profile set to 1. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 195: Tls Profile 2)

    The IP server connection timeout. If no activity for this timeout then the connection is closed. When set to 0 the connection is closed immediately after data is sent.] Parameter Range 10 - 0xFFFF; (x 100 ms) Default 3000 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 196: Do (Device Options)

    280 mA 2.6 A 2G active mode 80 mA Bitfield Description Enable Remote Manager support Controls whether Remote Manager is enabled. Digi recommends that Remote Manager remains enabled. Enable 2G fallback fallback. Enable USB Direct Reserved for future use Enable the...

  • Page 197: Pg (Ping)

    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 XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 198: P# (Destination Phone Number)

    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 Parameter range 0 - 128 ASCII characters Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 199: Od (Operating Destination Address)

    IP (IP Protocol) sets the protocol used. For more information on using incoming connections, see Socket behavior. Parameter range 0 - 0xFFFF Value Description Disabled Non-0 Enabled on that port Default Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 200: La (Lookup Ip Address Of Fqdn)

    Non-standard baud rates: 0x4B0 - 0x0EC400 Note On XBee 3 Cellular firmware versions ending in *13 or earlier, the minimum baud rate is 2400 and the maximum is 230400. Parameter Description 1200 b/s Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 201: Nb (Parity)

    Default 0x00 SB (Stop Bits) Sets or displays the number of stop bits for the UART. Parameter range 0 - 1 Value Description One (1) stop bit. Two (2) stop bits. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 202: Packetization Timeout)

    UART. When API is enabled the UART data must be formatted as API frames because Transparent mode is disabled. See Modes for more information. Parameter range 0x00 - 0x05 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 203: Ib (Cellular Component Baud Rate)

    Bypass mode (DEPRECATED. For diagnostic use only) Default IB (Cellular Component Baud Rate) Note Digi does not recommend using bypass mode. You should use USB Direct mode instead. Sets the serial interface baud rate for communication between the XBee CPU and the cellular component when in bypass mode.

  • Page 204: I/O Settings Commands

    Default D1 (DIO1/AD1) Sets or displays the DIO1/AD1 configuration (pin 19). Parameter range 0 - 6 Parameter Description Disabled SPI_ATTN Digital input Digital output, low Digital output, high C SCL Default Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 205: D2 (Dio2/Ad2)

    Sets or displays the DIO3/AD3 configuration (pin 17). Parameter range 0 - 5, 7 Parameter Description Disabled SPI_SSEL Analog input Digital input Digital output, default low Digital output, default high MicroPython UART1 CTS Default Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 206: D4 (Dio4)

    0, 1, 3 - 5 Parameter Description 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). Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 207: D7 (Dio7/Cts)

    Flow control (output) Digital input 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 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 208: D9 (Dio9/On_Sleep)

    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 - 5 Parameter Description Disabled RSSI PWM0 output Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 209: P1 (Dio11/Pwm1 Configuration)

    Digital output, default low Digital output, default high C SDA USB direct Default P2 (DIO12 Configuration) Sets or displays the DIO12 configuration (pin 4). Parameter range 0, 1, 3 - 5, 7 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 210: P3 (Dio13/Dout)

    0, 1 Parameter Description Disabled UART DOUT enabled Default P4 (DIO14/DIN) Sets or displays the DIO14/DIN configuration (pin 3). Parameter range 0 - 1 Parameter Description Disabled UART DIN enabled Default Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 211: Pd (Pull Direction)

    DIO2/AD2 pin 19 DIO1/AD1 pin 20 DIO0/AD0 DIO6/RTS pin 16 pin 9 DIO8/SLEEP_REQUEST DIO14/DIN pin 3 pin 15 DIO5/ASSOCIATE DIO9/On/SLEEP pin 13 pin 4 DIO12 pin 6 DIO10 pin 7 DIO11 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 212: M0 (Pwm0 Duty Cycle)

    16-bit two’s complement format. For example, 0x1A = 26 °C, and 0xF6 = -10 °C. Parameter range 0 - 0xFF which indicates degrees Celsius displayed in 8-bit two's complement format. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 213: Is (Force Sample)

    Number of samples 1 byte Digital channel mask 2 bytes Analog chanel mask 1 byte Samples 2 bytes each Parameter range Default Sleep commands The following AT commands are sleep commands. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 214: Sm (Sleep Mode)

    Default 0x7530 (5 minutes) ST (Wake Time) Sets or displays the time to spend awake in cyclic sleep modes. Parameter range 0x1 - 0x36EE80 (x 1 ms) Default 0xEA60 (60 seconds) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 215: Command Mode Options

    Set the required period of silence before and after the command sequence characters of the Command mode sequence (GT + CC + GT). The period of silence prevents inadvertently entering Command mode. Parameter range 0x2 - 0x6D3 (x 1 ms) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 216: Micropython Commands

    Interact with the XBee Smart Modem using MicroPython. PY is a command with sub-commands. These sub-commands are arguments to PY. Note You can use the PY command options to control MicroPython from Digi Remote Manager. Refer to the Digi MicroPython Programming Guide.

  • Page 217: Firmware Version/Information Commands

    Shows detailed version information including the application build date and time. Parameter range Default Set in firmware HV (Hardware Version) Display the hardware version number of the device. Parameter range 0 - 0xFFFF [read-only] Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 218: Hs (Hardware Series)

    Cellular network registration denied. 0x2A Airplane mode. 0x2B USB Direct active. Modem shut down. See (Shutdown). 0x2D 0x2E Low voltage shut down. 0x2F Bypass mode active. 0x30 An upgrade is in process. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 219: Ftp Ota Update Indication)

    The table below shows the FOTA parameters that can be set and their default values. Note Any of the parameter commands in the table below will return ERROR if the entered parameter is invalid or if a FOTA has already been initiated. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 220: Rj (Network Reject Cause)

    Refer to your Thales documentation for code reference. Parameter range Default Diagnostic interface commands The following AT commands are diagnostic interface commands. DI (Remote Manager Indicator) Displays the current Remote Manager status for the XBee. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 221: Ci (Protocol/Connection Indication)

    Tried to send but could not. 0x02 Invalid parameters (bad IP/host). 0x10 Not registered to the cell network. 0x11 Cellular component not identified yet. 0x12 DNS query lookup failure. 0x13 Socket leak 0x20 Bad handle. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 222 No server - timed out on connection. 0x25 Unknown server - DNS lookup failed. 0x26 Connection refused. 0x27 Connection lost. 0x28 Unknown. 0x2A FIN close by peer. 0x2B RST close by peer. 0x2C Inactivity Timeout. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 223: As (Active Scan For Network Environment Data)

    S, and keys for the fields are MCC, MNC, Area, CID, and Signal. Each line describes a particular cell and only those values determined during a single scan are reported. Example atas S MCC:311 MNC:480 Area:48707 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 224: Execution Commands

    CAUTION! This command is for advanced users, and you should only use it if the cellular component becomes completely stuck while in Bypass mode. Normal users should never need to run this command. See the FR (Force Reset) command instead. Range Default Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 225: File System Commands

    Directory names end with a forward slash (/) to differentiate them from files.  Secure files end with a hash mark (#) and you cannot download them. <DIR> ./ <DIR> ../ <DIR> cert/ Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 226: Atfs Put Filename

    Report on the size of the filesystem, showing bytes in use, available, marked bad and total. The report ends with a blank line, as with most multi-line AT command output. Example output: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 227: Atfs Format Confirm

    XBee AT Command processing, leading zeroes are not included in the response when in command mode. Parameter range Default BP (Bluetooth Advertisement Power Level) Sets or displays the output power level that will be used for Bluetooth advertisements. Parameter range 0x0 - 0x3 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 228: Bt (Bluetooth Enable)

    XBee device does not allow for 0 to be valid salt. If the value is 0, SRP is disabled and you will not be able to authenticate using Bluetooth. Parameter range 0 - FFFFFFFF Default Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 229: V, $W, $X, $Y (Srp Password Verifier)

    Sets up a constant TLS connection with SM/UDP still enabled. Default 6 (Bits 1 and 2 are enabled by default.) DF (Remote Manager Status Check Interval) Defines the number of minutes between polls for Remote Manager activity. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 230: Eq (Remote Manager Fqdn)

    Configure Remote Manager keepalive interval. Note Changing this value causes any currently active Remote Manager connections to be closed and recreated. Parameter range 10 - 7200 (x 1 s) Default 0x258 (600 seconds) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 231: D (Remote Manager Certificate)

    Reports the time between attempts to upload metrics. The time is measured in minutes. Metrics which cannot be collected or reported at any particular time are skipped until the next attempt. Parameter range 1 to 0xFFFF Value Description 0x3c One hour. Default 0x3c Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 232: Hm (Health Metrics)

    The metrics are set to 0 after reset or after the metrics are reported to Remote Manager. This is reported to the "metrics/link_deactivations" Data Stream in Remote Manager for the devices. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 233: Er (Remote Manager Tcp Port Override)

    Value is 0: The default Remote Manager UDP port is used. Value is non-zero: Specify the UDP port that should be used. The default Remote Manager UDP port is overridden. The default UDP port is 0xCE1. Parameter range 0x0 - 0xFFFF Default Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 234: Mt (Remote Manager Idle Timeout)

    Up to 20 ASCII characters Default One ASCII space character (0x20) KC (Contact Information) Sets or displays user-defined contact information for the XBee displayed in Remote Manager. Range Up to 20 ASCII characters Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 235: Socket Commands

    The list is separated by carriage returns (<CR>) and terminated with an additional carriage return. In both API and command mode the payload/output will have the following format: ID<CR> STATE<CR> PROTOCOL<CR> LOCAL_PORT<CR> REMOTE_PORT<CR> REMOTE_ADDRESS<CR> <CR> Field Description The socket ID. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 236: Gnss Commands

    If no location has been found within that maximum time, the GP command returns an error message: ERROR If a location is found, it returns a comma-delimited string as follows: Time_of_Lock_In_Seconds_From_Y2K,Latitude,Longitude,Altitude,Number_Of_Satellites Parameter range Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 237: Go (Gps Options)

    Sets the voltage threshold in millivolts at which the XBee enters a shutdown state. You must enable this feature by setting the DO command bit 4. See Low voltage shutdown. Parameter range 0xA28 - 0xC80 mV Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 238: M (Low Voltage Shutdown Reset Offset)

    XBee recovers from a shutdown state by resetting. You must enable this feature by setting the command bit 4. See Low voltage shutdown. Parameter range 0x64 - 0x2BC mV Default 0xC8 mV Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 239: Operate In Api Mode

    Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 240: Api Mode Overview

    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® 3 Cat 1 Smart Modem User Guide...

  • Page 241: Api Operation With Escaped Characters (Ap Parameter = 2)

    To escape an interfering data byte, insert 0x7D and follow it with the byte to be escaped (XORed with 0x20). The following data bytes need to be escaped: 0x7E: start delimiter 0x7D: escape character Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 242 Frame type is the API frame type identifier. It determines the type of API frame and indicates how the Data field organizes the information. Data contains the data itself. This information and its order depend on the what type of frame that the Frame type field defines. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 243 FF. 01 + 01 + 50 + 01 + 00 + 48 + 65 + 6C + 6C + 6F + B8 = 2FF Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 244 GNSS Start Raw NMEA, Stop Raw NMEA, or One Shot Request - 0x3D GNSS Start Raw NMEA, Stop Raw NMEA, or One Shot Response - 0xBD GNSS Raw NMEA Response - 0xBE GNSS One Shot Response - 0xBF Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 245: Api Frames

    The response for this command is also an AT Command Response frame (0x88). Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 246: Transmit (Tx) Sms - 0X1F

    A TX Request message causes the device to transmit data in IPv4 format. A TX request frame for a new destination creates a network socket. After the network socket is established, data from the Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 247 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 XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 248: Tx Request With Tls Profile - 0X23

    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 XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 249: At Command Response - 0X88

    Status 1 = ERROR 2 = Invalid command 3 = Invalid parameter Parameter Byte Register data in binary format. If the register was set, then this value field is not returned. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 250: Transmit (Tx) Status - 0X89

    Invalid TCP port 0x7A Invalid host address 0x7B Invalid data mode Invalid interface. See User Data Relay - 0x2D. 0x7C Interface not accepting frames. See User Data Relay - 0x2D. 0x7D Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 251: Modem Status - 0X8A

    The BLE Connect and BLE Disconnect events are reported over the UART/SPI interface in API mode when a valid Bluetooth connection has been made and API mode has been unlocked, and also when an unlocked connection disconnects. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 252: Receive (Rx) Packet: Sms - 0X9F

    The address in the example below is for a source address of address 192.168.0.104. 32-bit big endian. 16-bit destination port MSB 8 The port that the packet was received on. 16-bit big endian. LSB 9 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 253: User Data Relay - 0X2D

    0x89) sent for errors. A value of 0 disables the TX Status frame. Byte 0 = Serial port (SPI, or UART when in API mode) Destination 1 = BLE interface 2 = MicroPython Data Variable Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 254: Example Use Cases

    Field value Data type Description Frame type 0xAD Byte Byte 0 = Serial port (SPI, or UART Source interface when in API mode) 1 = BLE 2 = MicroPython Data Variable Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 255: Ble Unlock Api - 0X2C

    Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Frame data fields Offset Description Frame type 0x2C = Request 0xAC = Response Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 256 Phase 2 (Server presents B and salt) Frame data field Offset in frame Length salt 4 bytes 128 bytes Phase 3 (Client presents M1) Frame data field Offset in frame Length Hash algorithm digest length (32 bytes for SHA256) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 257: Example Sequence To Perform At Command Xbee Api Frames Over Ble

    When successful, the response arrives in one or more indications. If your stack does not do it for you, remember to acknowledge each indication as it is received. Note that you are Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 258: Ble Unlock Response - 0Xac

    If the status field is non-zero, which indicates an error, the socket ID will be set to 0xFF and the socket will not be opened. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 259: Socket Option Request - 0X41

    If the Option Data field is zero-length the request acts as a query, and the Socket Option Response frame (0xC1) reports the current effective value. Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 260: Socket Option Response - 0Xc1

    API frame format. Field Field name value Data type Description Frame type 0xC1 Byte Frame ID Byte Identifier provided in request. Socket ID Byte The socket ID for which modification was requested. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 261: Socket Connect - 0X42

    A reference identifier used to match status responses. If set to 0, the device does not send a response. Socket ID Byte ID of the socket to connect. Destination port 16-bit big endian Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 262: Socket Connect Response - 0Xc2

    Successfully started the connection process 0x01 Invalid destination address type 0x02 Invalid parameter: address or port 0x03 Connection already in progress 0x04 Already connected 0x05 Unknown error 0x20 Invalid socket ID Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 263: Socket Close - 0X43

    Frame ID Byte A reference identifier used to match status responses. Socket ID Byte ID of the socket that has been closed. 0x00 = Success Status Byte 0x20 = Bad socket ID Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 264: Socket Send (Transmit) - 0X44

    UDP connection before you attempt a SendTo in order to assign a source port. Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 265: Socket Bind/Listen - 0X46

    A reference identifier used to match status responses. If set to 0, the device does not send a response. Socket ID Byte The socket ID to listen on. Source port 16-bit big endian The port to listen on. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 266: Socket Listen Response - 0Xc6

    The XBee Cellular modem generates this frame when an incoming connection is accepted on a listener socket. This frame contains the original listener's socket ID and a new socket ID of the incoming connection, along with the connection's remote address information. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 267: Socket Receive - 0Xcd

    The XBee cellular modem uses this frame when it receives RF data on the specified socket. This frame is sent only for UDP sockets that have not used a Socket Connect - 0x42 frame to connect, providing addressing information about the source. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 268: Socket Status - 0Xcf

    The following table provides the contents of the frame. For details on frame structure, see API frame format. Field name Size Description Frame type Socket Status frame type (0xCF) Socket ID Socket ID for status reported Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 269: Gnss Start Raw Nmea, Stop Raw Nmea, Or One Shot Request - 0X3D

    0x05 = Start Raw NMEA 0x06 = Stop Raw NMEA 16-bit big Endian Timeout in seconds. Timeout Only used for One shot.  0 = Return Cached value 1 = 65535 in seconds Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 270: Gnss Start Raw Nmea, Stop Raw Nmea, Or One Shot Response - 0Xbd

    Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Field name Field value Data type Description NMEA Variable Raw NMEA string. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 271: Gnss One Shot Response - 0Xbf

    Longitude in decimal degrees, multiplied by 10 million. Positive Values are East of the Prime Meridian, Negative values are West Endian of the Prime Meridian. Altitude 32-bit Altitude in millimeters. Endian Satellites Byte Total number of satellites in use. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 272: File System Api Frames

    File system API frames Local File System Request - 0x3B Local File System Response - 0xBB Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 273: Local File System Request - 0X3B

    0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). File System Commands Value Command File Open 0x01 File Close 0x02 File Read 0x03 File Write 0x04 File Hash 0x08 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 274: File Open - 0X01

    This is useful for protecting MicroPython source code on the device. The SECURE bit is only valid when also setting the WRITE bit and either creating a new file (CREATE + EXCLUSIVE) or replacing an existing file (TRUNCATE). Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 275: File Close - 0X02

    Close an open file and release its File Handle. Request Offset Size Frame Field Description File System Command 8-bit File Close - 0x02 File Handle Value returned from File Open - 0x01 response. 16-bit Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 276: File Read - 0X03

    Size Frame Field Description File System Command 8-bit File Hash - 0x08 Path ID Get Path ID - 0x1C for a description. 16-bit File Name Pathname relative to Path ID. variable Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 277: File Write - 0X04

    Success - 0x00 8-bit 16-bit File Handle Value sent in request. 32-bit Current Offset Current offset of file after writing Data from Request. Directory Create - 0x10 Description Create a directory. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 278: Directory Open - 0X11

    Request. An empty directory returns a single entry with only the ENTRY_IS_LAST flag set, and a 0-byte Entry Name. A response ending with an ENTRY_IS_LAST flag automatically closes the Directory Handle. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 279: Directory Close - 0X12

    The host can send this frame to indicate that it is done reading the directory and no longer needs the Directory Handle. Note that the Directory Handle is automatically closed and no longer valid after receiving a Response with the ENTRY_IS_LAST flag set. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 280: Directory Read - 0X13

    The full, absolute path of the Path ID is included in the Response only if can fit. Any code used to process the response needs to take that into account and handle an empty Full Pathname field. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 281: Delete - 0X2F

    16-bit Path Name Pathname of file or empty directory to delete. variable Volume Info - 0x40 Description Get volume information: used space, available space, and unusable bytes on volume. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 282: Volume Format - 0X4F

    Frame ID. The contents of the variable-length Response Data field appear in the documentation for each File System Command. Format The following table provides the contents of the frame. For details on frame structure, see API frame format. Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 283 0x51 File/Directory already exists 0x52 File/Directory does not exist 0x53 Invalid name 0x54 File operation on directory 0x55 Cannot delete non-empty directory 0x56 Attempt to read past EOF (end of file) Digi XBee® 3 Cat 1 Smart Modem User Guide...
  • Page 284 Hardware failure 0x58 Volume offline/format required 0x59 Volume full 0x5A Operation timed out 0x5B Busy (wait for prior command to complete then try again) 0x5C Resource failure (memory allocation failed, try again) Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 285: Regulatory Firmware

    Install the regulatory firmware You can install the regulatory firmware from either XCTU or Remote Manager. Install regulatory firmware using XCTU You can install the regulatory firmware on your XBee using XCTU. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 286: Install Regulatory Firmware Using Remote Manager

    Digi XBee 3 Cellular LTE CAT 1 support page. b. Scroll down to the Firmware Updates section. c. Locate and click Digi XBee 3 Cellular LTE CAT 1 Regulatory firmware to download the zip file. d. Unzip the file. Log into Remote Manager.

  • Page 287: Configure Regulatory Firmware For Testing The Bluetooth Radio

    The protocol has also been extended with the two commands shown in the table below to allow changing the transmit power and to override the packet type to use an unmodulated carrier. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 288: Example

    3. Start test mode. See %1 (Start test mode). 4. Perform regulatory tests, using the regulatory commands. 5. Stop test mode. See %2 (Stop test mode) 6. Disable test mode. See %# (Enable/disable test mode). Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 289: (Enable/Disable Test Mode)

    %1 (Start test mode) Use this command to start test mode. You must perform this command at least once before you perform any other regulatory command. Examples Start test mode: AT%1 Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 290: Stop Test Mode)

    25 channels in each LTE band. Parameter range 0 - 65535 This is specified in decimal to conform to standard representations found in specifications without need for translation. Default Examples Set EARFCN to 5110: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 291: Get The Earfcn)

    Set transmit power to 0 dBm: AT%9000 Set transmit power to -1 dBm: AT%9FF0 %A (Get transmit power) Use this command to get the transmit power value set using AT%9. Parameter range Example Get transmit power: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 292: D (Start Receive Mode)

    Parameter range for North America Cat 1 Value Description UARFCN (3G/UMTS) excluding band 19 UARFCN (3G/UMTS) band 19 EARFCN (4G/LTE) %I (Get channel mapping) Use this command to get the channel mapping. Examples Get channel mapping: AT%I Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 293: (Query Test State)

    Inactive (Test mode not yet started.) Transition (Attempting to activate test mode.) Off (Test mode started, but no active test.) Receive mode Transmit mode An error occurred Example Query test state: AT%? Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 294: Troubleshooting

    1. Click the Discover radio modules button 2. Select all of the ports to be scanned. 3. Click Next and then Finish. A dialog notifies you of the devices discovered and their details. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 295: Other Possible Issues

    4. If you have a driver installed and updated but still have issues, on Windows 10 you may have to enable VCP on the driver; see Enable Virtual COM port (VCP) on the driver. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 296: Enable Virtual Com Port (Vcp) On The Driver

    5. Right-click the USB controller and select Properties; a dialog displays. 6. Select the Advanced tab. 7. Check Load VCP. 8. Click OK. 9. Unplug the board and plug it back in. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 297: Correct A Macos Java Error

    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® 3 Cat 1 Smart Modem User Guide...

  • Page 298: Unresponsive Cellular Component In Bypass Mode

    XBee Smart Modem software. If AI is 0x2F, Bypass mode should work. If not, look at the status codes in AI (Association Indication) for guidance. 2. You can send the !R (Modem Reset) command to reset only the cellular component. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 299: Not On Expected Network After Apn Change

    AT+IPR setting you will need to match it with the IB setting to maintain communication. Note Digi does not recommend using bypass mode. You should use USB Direct mode instead. Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 300: Regulatory Information

    If the antenna is mounted at least 21 cm from nearby persons, the application is considered a mobile application. The antennas below have been approved for use with this module. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas.
  • Page 301 6.10 dBi LTE Band 7 5.00 dBi 8.01 dBi LTE Band 8 5.00 dBi LTE Band 12 5.00 dBi 8.70 dBi 5.61 dBi LTE Band 13 5.00 dBi 9.16 dBi 5.93 dBi LTE Band 14 9.23 dBi Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 302: Fcc Publication 996369 Related Information

    FCC grant which includes significant extra testing and cost. If an embedded trace or chip antenna is desired contact a Digi sales representative for information on how to engage with a lab to get the modified FCC grant.

  • Page 303: Labeling Requirements For The Host Device: Fcc And Ised

    En l'absence d'étiquette, l'appareil hôte doit porter une étiquette donnant le FCC ID et le IC du module, précédé des mots « Contient un module d'émission », du mot « Contient » ou d'une formulation similaire exprimant le même sens, comme suit: Digi XBee® 3 Cat 1 Smart Modem User Guide...

  • Page 304: Regulatory Information

    Regulatory Information: ISED. 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. Interference statement This device complies with Part 15 of the FCC Rules and ISED (Innovation, Science, and Economic Development Canada) license-exempt RSS standard(s).

  • Page 305: Rf Exposure

    The following regulatory information is for Innovation, Science and Economic Development Canada (ISED). Modification statement: ISED Digi International n’approuve aucune modification apportée à l’appareil par l’utilisateur, quelle qu’en soit la nature. Tout changement ou modification peuvent annuler le droit d’utilisation de l’appareil par l’utilisateur.

  • Page 306: Rf Exposure: Ised

    Antenne(s) utilisé pour cet émetteur doit être installé pour fournir une distance de séparation d'au moins 21 cm à partir de toutes les personnes et ne doit pas être situé ou fonctionner en conjonction avec tout autre antenne ou émetteur. Digi XBee® 3 Cat 1 Smart Modem User Guide...

This manual is also suitable for:

Xb3-c-g1-ut-001

Table of Contents