Digi Xbee3® Cellular LTE Cat 1 Smart Modem
Total Page:16
File Type:pdf, Size:1020Kb
Digi XBee3® Cellular LTE Cat 1 Smart Modem User Guide Revision history—90002253 Revision Date Description F February Added information for XBIB-C-TH and XBIB-C-GPS development boards 2019 G April 2019 Added information for Digi Remote Manager® H June 2019 Added information for Clean shutdown and securing the connection between and XBee and Remote Manager. Added FCC publication 996369 related information. J July 2019 Added socket information. Additional edits. K September Added firmware update information. 2019 Added PPP information. Updated antenna information. 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. © 2019 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: www.digi.com/howtobuy/terms Send comments Documentation feedback: To provide feedback on this document, send your comments to [email protected]. Customer support Digi Technical Support: Digi offers multiple technical support plans and service packages to help our customers get the most out of their Digi product. For information on Technical Support plans and Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide 2 pricing, contact us at +1 952.912.3444 or visit us at www.digi.com/support. Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide 3 Contents Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide Applicable firmware and hardware 14 SIM cards 14 Get started with the XBee Smart Modem Identify the kit contents 16 Connect the hardware 17 Configure and update your XBee with XCTU 18 Add a device 18 Check for cellular registration and connection 19 Update to the latest modem firmware from XCTU 19 Cellular service 20 XBee connection examples Connect to the Echo server 22 Connect to the ELIZA server 24 Connect to the Daytime server 26 Send an SMS message to a phone 28 Perform a (GET) HTTP request 30 Get started with CoAP 32 CoAP terms 32 CoAP quick start example 32 Configure the device 33 Example: manually perform a CoAP request 33 Example: use Python to generate a CoAP message 34 Connect to a TCP/IP address 37 Get started with MQTT 38 Example: MQTT connect 38 Send a connect packet 40 Example: send messages (publish) with MQTT 41 Example: receive messages (subscribe) with MQTT 42 Use MQTT over the XBee Cellular Modem with a PC 43 Software libraries 46 Get started with MicroPython About MicroPython 48 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide 4 Why use MicroPython 48 MicroPython on the XBee Smart Modem 48 Use XCTU to enter the MicroPython environment 48 Use the MicroPython Terminal in XCTU 49 Troubleshooting 49 Example: hello world 49 Example: turn on an LED 49 Example: code a request help button 50 Enter MicroPython paste mode 51 Catch a button press 52 Send a text (SMS) when the button is pressed 53 Add the time the button was pressed 54 Example: debug the secondary UART 55 Exit MicroPython mode 55 Other terminal programs 56 Tera Term for Windows 56 Use picocom in Linux 57 Get started with BLE Enable BLE on an XBee device 59 Enable BLE and configure the BLE password using XCTU 59 Get the Digi XBee Mobile phone application 60 Connect with BLE and configure your XBee device 61 BLE reference 61 BLE advertising behavior and services 61 Device Information Service 61 XBee API BLE Service 62 API Request characteristic 62 API Response characteristic 62 Get started with Digi Remote Manager Create a Remote Manager account and add devices 64 Create a Remote Manager account 65 Add an XBee Smart Modem to Remote Manager 65 Verify the connection between a device and Remote Manager 66 Configure Remote Manager features by scheduling tasks 66 Overview: Create a schedule for a set of tasks 66 Examples 67 Example: Read settings and state using Remote Manager 67 Example: Configure a device from Remote Manager using XML 68 Example: Update XBee firmware using Remote Manager 69 Example: Update MicroPython from Remote Manager using XML 70 Restore persistent connection to a remote XBee 74 Manage data in Remote Manager 76 Review device status information from Remote Manager 76 Update the firmware from Remote Manager 76 Update the cellular component firmware using Remote Manager 78 Update the firmware using web services in Remote Manager 80 Manage secure files in Remote Manager 82 Remote Manager reference 83 Enable SM/UDP 83 Disconnect 84 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide 5 Configure XBee settings within Remote Manager 84 Update the firmware on your XBee Update the modem firmware on the XBee 87 Update the Telit cellular module firmware 87 Use a host processor to update the modem firmware for XBee3 devices over UART prior to *10 87 Update the modem firmware 87 Transfer the firmware to the device 90 Use a host processor to update the modem firmware for XBee3 devices over UART after *10 90 Update the modem firmware 91 Send a firmware image 91 Update the Telit modem firmware 92 Requirements 92 Update the firmware 93 Technical specifications Interface and hardware specifications 98 RF characteristics 98 Networking specifications 98 Power requirements 98 Power consumption 99 Electrical specifications 99 Regulatory approvals 100 Hardware Mechanical drawings 103 Pin signals 103 Pin connection recommendations 104 RSSI PWM 105 SIM card 105 Associate LED functionality 105 Development boards 107 XBIB-U-DEV reference 107 XBIB-CU-TH reference 109 XBIB-C-GPS reference 113 Interface with the XBIB-C-GPS module 114 Antenna recommendations Antenna connections 117 Keepout area 118 Through-hole keepout 119 Antenna placement 119 Design recommendations Cellular component firmware updates 121 Power supply considerations 121 Recommended application circuit 121 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide 6 Heat considerations and testing 122 Heat sink guidelines 123 Add a fan to provide active cooling 124 Custom configuration: Create a new factory default 124 Set a custom configuration 125 Clear all custom configurations on a device 125 Clean shutdown 125 SD (Shutdown) command 125 Sleep feature 126 Airplane mode 126 Cellular connection process Connecting 128 Cellular network 128 Data network connection 128 Data communication with remote servers (TCP/UDP) 128 Disconnecting 128 Modes Select an operating mode 131 Transparent operating mode 132 API operating mode 132 Bypass operating mode (DEPRECATED) 132 Enter Bypass operating mode 133 Leave Bypass operating mode 133 Restore cellular settings to default in Bypass operating mode 133 USB direct mode 133 Enable USB direct mode 133 Configure and use PPP with a Digi XBee3 Cellular CAT 1 AT&T modem 134 Command mode 137 Enter Command mode 137 Troubleshooting 138 Send AT commands 138 Response to AT commands 139 Apply command changes 139 Make command changes permanent 139 Exit Command mode 139 MicroPython mode 139 Sleep modes About sleep modes 142 Normal mode 142 Pin sleep mode 142 Cyclic sleep mode 142 Cyclic sleep with pin wake up mode 142 The sleep timer 142 MicroPython sleep behavior 142 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide 7 Power saving features and design recommendations Airplane mode 145 Serial communication Serial interface 147 Serial data 147 UART data flow 147 Serial buffers 147 CTS flow control 148 RTS flow control 148 Enable UART or SPI ports 148 SPI operation SPI communications 150 Full duplex operation 151 Low power operation 152 Select the SPI port 152 Force UART operation 153 Data format 153 File system Overview of the file system 155 Directory structure 155 Paths 155 Secure files 155 XCTU interface 156 Encrypt files 156 SMS behaviors SMS encoding 156 Socket behavior Supported sockets 158 Best practices when using sockets 158 Sockets and Remote Manager 158 Sockets and API mode 158 Socket timeouts 158 Socket limits in API mode 158 Enable incoming TCP connections 159 API mode behavior for outgoing TCP and TLS connections 159 API mode behavior for outgoing UDP data 160 API mode behavior for incoming TCP connections 160 API mode behavior for incoming UDP data 161 Transparent mode behavior for outgoing TCP and TLS connections 161 Transparent mode behavior for outgoing UDP data 161 Transparent mode behavior for incoming TCP connections 161 Digi XBee3 Cellular LTE Cat 1 Smart Modem User Guide 8 Transparent mode behavior for incoming UDP connections 162 Extended Socket frames Examples 163 Available Extended Socket frames 164 Extended Socket example: Single HTTP Connection 164 Send a Socket Create frame 164 Receive a Socket Create response 165 Send Socket Connect 165 Receive a Socket Connect Response 165 Receive a Socket Status 166 Send HTTP Request using Socket Send frame 166 Receive TX Status 167 Receive one or more Receive Data frames 167 Receive Socket Status indicating closed connection 168 Extended Socket example: UDP 168 Send a Socket Create frame 168 Receive a Socket Create response 169 Bind local source addres 169 Receive Bind/Listen Response 169 Send to Digi