Digi Xbee® 3 Cellular LTE-M/NB-Iot Global Smart Modem User Guide 2
Total Page:16
File Type:pdf, Size:1020Kb
Digi XBee® 3 Cellular LTE-M/NB-IoT Smart Modem User Guide Revision history—90002258 Revision Date Description T December Updated update instructions: over the wire and over the air. 2020 Updated command: D0 (DIO0/AD0). New command: FC (Frequency Channel Number). Updated Power Saving Mode (PSM). U January Added design recommendations for SIM cards. 2021 Updated the instructions for configuring the regulatory firmware for testing the cellular component. Updated Socket Connect - 0x42. Updated Socket Connect Response - 0xC2. Updated commands: CP (Carrier Profile) and N# (Preferred Network Technology). Updated HM (Health Metrics). Updated Regulatory approvals and added Brazil (ANATEL) information. V January Updated cellular antenna information. 2021 W May 2021 Updated the example to include information about Allow Offline option. Updated prerequisites: Update an XBee module cellular component using FOTA (over the air) Updated maximum baud rates. Updated Enable SM/UDP. Added PG (Ping). X August Added CE and UKCA OEM labeling requirements in the Europe (CE) 2021 regulatory section. Added Safety instructions. Added OT (Operating Technology) command. Updated Clean shutdown Trademarks and copyright Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners. © 2021 Digi International Inc. All rights reserved. Disclaimers 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. Digi may make improvements and/or changes in this manual or in the product(s) and/or the program(s) described in this manual at any time. Warranty To view product warranty information, go to the following website: Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 2 www.digi.com/howtobuy/terms Customer support Gather support information: Before contacting Digi technical support for help, gather the following information: Product name and model Product serial number (s) Firmware version Operating system/browser (if applicable) Logs (from time of reported issue) Trace (if possible) Description of issue Steps to reproduce Contact Digi technical support: Digi offers multiple technical support plans and service packages. Contact us at +1 952.912.3444 or visit us at www.digi.com/support. Feedback To provide feedback on this document, email your comments to [email protected] Include the document title and part number (Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide, 90002258 W) in the subject line of your email. Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 3 Contents Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide Applicable firmware and hardware 17 Safety instructions 17 XBee modules 17 SIM cards 17 NB-IoT network 18 Get started with the XBee Smart Modem Identify the kit contents 20 Determine cellular service and acquire a SIM card 22 US customers 22 European customers 22 Cellular service 22 Connect the hardware 23 Install and upgrade XCTU 24 Add a device to XCTU 24 Update the device and cellular firmware using XCTU 25 Configure your module for cellular connectivity 25 US customers 25 European customers 26 Check for cellular registration and connection 26 XBee connection examples Connect to the Echo server 29 Connect to the ELIZA server 31 Connect to the Daytime server 33 Perform a (GET) HTTP request 35 Connect to a TCP/IP address 36 Debugging 36 Software libraries 37 Get started with MicroPython About MicroPython 39 Why use MicroPython 39 MicroPython on the XBee Smart Modem 39 Use XCTU to enter the MicroPython environment 39 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 4 Use the MicroPython Terminal in XCTU 40 Troubleshooting 40 Example: hello world 40 Example: Turn on an LED 40 Example: debug the secondary UART 41 Exit MicroPython mode 42 Other terminal programs 42 Tera Term for Windows 42 Use picocom in Linux 43 Get started with BLE On XBee 3 Cellular firmware ending in x16 or newer 45 On XBee 3 Cellular firmware ending in x15 or newer 45 On XBee 3 Cellular firmware ending in x14 or older 46 Enable BLE on an XBee device 46 Enable BLE and configure the BLE password using XCTU 46 Get the Digi XBee Mobile phone application 47 Connect with BLE and configure your XBee device 48 BLE reference 48 BLE advertising behavior and services 48 Device Information Service 48 XBee API BLE Service 48 API Request characteristic 49 API Response characteristic 49 Get started with Digi Remote Manager Create a Remote Manager account and add devices 50 Create a Remote Manager account 51 Add an XBee Smart Modem to Remote Manager 51 Verify the connection between a device and Remote Manager 52 Configure Remote Manager features by scheduling tasks 52 Overview: Create a schedule for a set of tasks 53 Examples 53 Example: Read settings and state using Remote Manager 53 Example: Configure a device from Remote Manager using XML 54 Example: Schedule a task to update the device firmware using Remote Manager 55 Example: Update MicroPython from Remote Manager using XML 57 Manage data in Remote Manager 60 Review device status information from Remote Manager 61 Manage secure files in Remote Manager 61 Remote Manager reference 62 Enable SM/UDP 62 TCP connection 63 Disconnect 64 Configure XBee settings within Remote Manager 64 Examples: IOT protocols with transparent mode Get started with CoAP 68 CoAP terms 68 CoAP quick start example 68 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 5 Configure the device 69 Example: manually perform a CoAP request 69 Example: use Python to generate a CoAP message 70 Get started with MQTT 72 Example: MQTT connect 72 Send a connect packet 74 Example: send messages (publish) with MQTT 75 Example: receive messages (subscribe) with MQTT 76 Use MQTT over the XBee Cellular Modem with a PC 77 Update the firmware Create a plan for device and cellular component firmware updates 82 Update the device and the cellular firmware using XCTU 83 Update the device and cellular firmware using XCTU and USB Direct access 83 Update the device firmware 85 Update the firmware from the Devices page in Remote Manager 85 Update the firmware using web services in Remote Manager 86 Use a host processor to update the modem firmware for XBee 3 devices over UART prior to *10 88 Use a host processor to update the device firmware for XBee 3 devices over UART after *10 90 Update the cellular firmware 92 Update an XBee module cellular component using FOTA (over the air) 92 Update an XBee module cellular component using API mode (over the wire) 94 Update the cellular module from a PC using the EasyFlash Firmware Update 97 Technical specifications Interface and hardware specifications 99 Cellular RF characteristics 99 Bluetooth RF characteristics 99 Cellular networking specifications 99 Power requirements 100 Power consumption 101 Electrical specifications 102 Regulatory approvals 103 Hardware Mechanical drawings 105 Pin signals 105 Pin connection recommendations 107 XBee header connector requirements 107 RSSI PWM 107 SIM card 108 Associate LED functionality 108 Development boards 110 XBIB-CU-TH reference 110 XBIB-C-GPS reference 114 Interface with the XBIB-C-GPS module 115 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 6 Antenna recommendations Antenna placement 117 Design recommendations Cellular component firmware updates 119 Power supply considerations 119 Minimum connection diagram 119 Heat considerations and testing 120 Custom configuration: Create a new factory default 120 Set a custom configuration 121 Clear all custom configurations on a device 121 Clean shutdown 121 SD (Shutdown) command 121 SIM cards 122 Cellular connection process Connecting 124 Cellular network 124 Data network connection 124 Data communication with remote servers (TCP/UDP) 124 Disconnecting 125 Modes Select an operating mode 127 Transparent operating mode 128 API operating mode 128 Command mode 128 Enter Command mode 128 Troubleshooting 129 Send AT commands 129 Response to AT commands 129 Apply command changes 130 Make command changes permanent 130 Exit Command mode 130 MicroPython mode 130 USB direct mode 131 Connect the hardware for USB Direct mode 131 Configure the data pins 132 Enable USB direct mode 132 Configure and use PPP with a Digi XBee 3 Cellular LTE-M/NB-IoT modem 133 Bypass operating mode (DEPRECATED) 136 Enter Bypass operating mode 136 Leave Bypass operating mode 137 Restore cellular settings to default in Bypass operating mode 137 Sleep modes About sleep modes 139 Digi XBee® 3 Cellular LTE-M/NB-IoT Global Smart Modem User Guide 7 Normal mode 139 Pin sleep mode 139 Cyclic sleep mode 139 Cyclic sleep with pin wake up mode 139 SPI mode and sleep pin functionality 139 The sleep timer 140 MicroPython sleep behavior 140 Power saving features and design recommendations Airplane mode 142 Power Saving Mode (PSM) 142 Enable PSM 142 Overview of PSM functionality on XBee 3 Cellular 142 PSM behavior 144 Low voltage shutdown 144 Deep Sleep mode 145 Serial communication Serial interface 147 Serial data 147 UART data flow 147 Serial buffers 148 CTS flow control 148 RTS flow control 148 Enable UART or SPI ports 148 I2C 149 SPI operation SPI communications 151 Full