manualshive.com logo in svg

Digi XBee Cellular LTE Cat 1, User Manual, Page: 9 / 91

Share
Download
Digi XBee Cellular LTE Cat 1 User Manual Download Page 9

Getting started with the XBee Cellular Modem
Development Kit

This section describes how to set up an XBee network and adjust the XBee Cellular Modem settings.

This section describes how to connect the hardware in the XBee Cellular Modem Development Kit, and
provides some examples you can use to communicate with the device.

Identify the kit contents

10

Cellular service

10

Connect the hardware

11

Configure the device using XCTU

12

Software libraries

12

XBIB-U_DEV reference

14

XBee Cellular Modem examples

16

Configure the XBee Cellular Modem using Device Cloud

25

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

9

Summary of Contents for XBee Cellular LTE Cat 1

Page 1: ...Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...

Page 2: ...epresent 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 fitne...

Page 3: ...SMS message to a phone 16 Connect to the ELIZA server 18 Connect to the echo server 19 Connect to the Daytime server 21 Connect to a TCP IP address 23 Perform a GET HTTP request 24 Configure the XBee...

Page 4: ...ng 40 Modes Select an operating mode 42 Transparent operating mode 42 API operating mode 43 Bypass operating mode 43 Enter Bypass operating mode 43 Leave Bypass operating mode 43 Boot the XBee Cellula...

Page 5: ...IP Address 56 LA Lookup IP Address of FQDN 56 OD Operating Destination Address 56 Serial interfacing commands 57 BD Baud Rate 57 NB Parity 57 SB Stop Bits 58 RO Packetization Timeout 58 FT Flow Contr...

Page 6: ...Transmit TX SMS 0x1F 75 Transmit TX Request IPv4 0x20 76 AT Command Response 0x88 77 Transmit TX Status 0x89 78 Modem Status 0x8A 79 Receive RX Packet SMS 0x9F 80 Receive RX Packet IPv4 0xB0 81 Socket...

Page 7: ...future proof design with flexibility to switch between wireless protocols or frequencies as needed Applicable firmware and hardware This manual supports the following firmware n 1005 It supports the f...

Page 8: ...Cat 1 Embedded Modem User Guide 8 National distributor Network Contact Phone number Email Ice Mobility Verizon direct Tom Puchala 847 876 1768 tom puchala icemobility com KORE Verizon MVNO Genesis Cro...

Page 9: ...n the XBee Cellular Modem Development Kit and provides some examples you can use to communicate with the device Identify the kit contents 10 Cellular service 10 Connect the hardware 11 Configure the d...

Page 10: ...ower supply Two antennas with U FL connectors One USB cable One XBee Cellular Modem One SIM card Cellular service The XBIB U DEV board comes in an anti static bag There is a label on the bag that prov...

Page 11: ...G Never insert or remove the SIM card while the device is powered 3 Connect the antennas to the XBee Cellular Modem by aligning the U FL connectors carefully then firmly pressing straight down to seat...

Page 12: ...4 In the Set port parameters window maintain the default values and click Finish 5 As XCTU locates radio modules they appear in the Discovering radio modules dialog box If your module could not be fo...

Page 13: ...re libraries Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 13 The XBee Java Library is a Java API The package includes the XBee library its source code and a collection of samples that help y...

Page 14: ...igi XBee Cellular LTE Cat 1 Embedded Modem User Guide 14 XBIB U_DEV reference This picture shows the XBIB U development board and the table that follows explains the callouts in the picture Number Ite...

Page 15: ...0 V Greater than 500 mA loads require a DC supply for correct operation Plug in the external power supply prior to the USB connector to ensure that proper USB communications are not interrupted 6 LED...

Page 16: ...working mode button 2 Select a device from the Radio Modules list XCTU displays the current firmware settings for that device 3 On the Configuration toolbar click the Default button to load the defaul...

Page 17: ...essages to the device from another cellular device 1 Ensure that the device is set up correctly with the SIM card installed and the antennas connected as described in Connect the hardware 2 Open XCTU...

Page 18: ...phone reply with the text connect with confidence and the XBee Cellular Modem outputs this reply from the UART Connect to the ELIZA server You can use the XBee Cellular Modem to chat with the ELIZA T...

Page 19: ...d type 52 43 121 77 and click the Write button 8 To enter the destination IP port number in the DE field type 2328 and click the Write button 9 Click the Consoles working mode button on the toolbar to...

Page 20: ...up correctly with the SIM card installed and the antennas connected as described in Connect the hardware 2 Open XCTU and click the Configuration working mode button 3 Select a device from the Radio Mo...

Page 21: ...rovides an example of this chat Connect to the Daytime server The Daytime server reports the current Coordinated Universal Time UTC value responding to any user input The following table explains the...

Page 22: ...ite button on the toolbar 6 To switch to TCP communication in the IP field select 1 and click the Write button 7 To enter the destination address of the daytime server in the DL field type 52 43 121 7...

Page 23: ...ed transmission mode to TCP communication DL Destination IP Address Target IP address The target IP address that you send and receive from For example a data logging server s IP address that you want...

Page 24: ...TU This example uses http httpbin org IP address 54 175 219 8 as the target website that responds to the HTTP request To perform a GET request 1 Ensure that the device is set up correctly with the SIM...

Page 25: ...evice Cloud through standards based web services This section describes how to configure and manage an XBee using Device Cloud For detailed information on using Device Cloud refer to the Device Cloud...

Page 26: ...the firmware XBee Cellular Modem supports Device Cloud firmware updates To perform a firmware update use the following steps 1 Download the updated firmware file for your device from Digi s support si...

Page 27: ...and hardware specifications 28 RF characteristics 28 Networking and carrier 28 Power requirements 28 Power consumption 29 Electrical specifications 29 Regulatory approvals 30 Digi XBee Cellular LTE C...

Page 28: ...l I O 13 I O lines ADC 4 10 bit analog inputs RF characteristics The following table provides the RF characteristics for the device Specification Value Modulation LTE 4G QPSK 16 QAM Transmit power 23...

Page 29: ...A Rx ACK current Active receive 3 3 V 530 mA N A Rx ACK current Active receive 5 V 360 mA N A RX Only current Active receive 3 3 V 300 mA N A Idle current Idle connected listening 3 3 V 143 mA N A Id...

Page 30: ...3 V 0 75 VDD_ IO II_IN Input leakage current High Z state I O connected to Ground or VDD_IO 0 1 100 nA RPU Internal pull up resistor Enabled 40 k RPD Internal pull down resistor Enabled 40 k Regulato...

Page 31: ...Antenna placement 34 SIM card 34 The Associate LED 34 Heat considerations 35 Heat sink considerations 35 Power supply considerations 36 Add a capacitor to the RESET line 36 Add a fan to provide active...

Page 32: ...signals The following table shows the pin assignments for the through hole device In the table low asserted signals have a horizontal line above signal name Pin Name Direction Default Description Pin...

Page 33: ...I O 5 16 RTS DIO6 Either Disabled Input Request to Send Flow Control Digital I O 6 17 AD3 DIO3 Either Disabled Analog Input 3 or Digital I O 3 18 AD2 DIO2 Either Disabled Analog Input 2 or Digital I O...

Page 34: ...dead zones because of reduced range and efficiency We recommend that antennas do not touch each other but the XBee Cellular Modem works if they do To optimize receive performance orient the two anten...

Page 35: ...ure is applied to a secure heat sink We recommend connecting the heat sink to the top side of the XBee Cellular Modem without covering the U FL connectors We do not recommend operating the unit above...

Page 36: ...1 78 C 78 C 78 C Power supply considerations When considering a power supply use the following design practices 1 Keep power supply ripple below 75 mV 2 The supply should handle 1 5 A 3 Place sufficie...

Page 37: ...become hot if you use it in the maximum upload or download scenarios see Heat considerations You can attach a fan to the device to provide active cooling If you attach a fan use P1 DIO11 PWM1 Configur...

Page 38: ...tion process Connecting 39 Cellular network 39 Data network connection 39 Data communication with remote servers TCP UDP 39 Disconnecting 39 SMS encoding 40 Digi XBee Cellular LTE Cat 1 Embedded Modem...

Page 39: ...ves its IP configuration and address 4 The AI Association Indication command now returns a 0 and the sockets become available Data communication with remote servers TCP UDP Once sockets become availab...

Page 40: ...Cellular Modem transmits SMS messages using the standard GSM 03 38 character set 1 Because this character set only provides 7 bits of space per character the XBee Cellular Modem ignores the most signi...

Page 41: ...Modes Select an operating mode 42 Transparent operating mode 42 API operating mode 43 Bypass operating mode 43 Command mode 44 Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 41...

Page 42: ...perating mode and 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 mo...

Page 43: ...o the cellular component In this mode the XBee Cellular Modem exposes all control of the cellular component s AT port through the UART Note The cellular component can become unresponsive in Bypass mod...

Page 44: ...e operating modes are controlled by the AP API Enable setting but Command mode is always available as a mode the device can enter while configured for any of the operating modes Enter Command mode To...

Page 45: ...ands for attention The AT is followed by two characters that indicate which command is being issued then by some optional configuration values To read a parameter value stored in the device s register...

Page 46: ...s not receive any valid AT commands within the time specified by CT Command Mode Timeout it returns to Transparent or API mode The default Command Mode Timeout is 10 seconds For an example of programm...

Page 47: ...es About sleep modes 48 Normal mode 48 Pin sleep mode 48 Cyclic sleep mode 48 Cyclic sleep with pin wake up mode 48 Airplane mode 48 The sleep timer 48 Digi XBee Cellular LTE Cat 1 Embedded Modem User...

Page 48: ...and wake for a short time to poll If you use the D7 command to enable hardware flow control the CTS pin asserts low when the device wakes and can receive serial data and de asserts high when the devic...

Page 49: ...essing commands 54 Serial interfacing commands 57 I O settings commands 59 I O sampling commands 61 Command mode options 62 Firmware version information commands 63 Diagnostic interface commands 64 Ex...

Page 50: ...values until the device is rebooted or you issue the CN Exit AT Command Mode or AC commands Parameter range N A Default N A FR Force Reset Resets the device The device responds immediately with an OK...

Page 51: ...ee Cellular Modem is not registered to the network Parameter range N A Default Set by the cellular carrier via the SIM card S ICCID Reads the Integrated Circuit Card Identifier ICCID of the inserted S...

Page 52: ...r component of the XBee Cellular Modem is fully turned off and no access to the cellular network is performed or possible Parameter range 0 1 0 Normal operation 1 Airplane mode Default 0 DV Antenna Di...

Page 53: ...cription 0x00 UDP 0x01 TCP 0x02 SMS 0x03 Reserved 0x04 SSL over TCP communication Default 0x01 TL SSL TLS Protocol Version Sets the SSL TLS protocol version used for the SSL socket If you change the T...

Page 54: ...Options Sets or displays whether Device Cloud support is enabled If the XBee Cellular Modem cannot establish a connection with Device Cloud it waits 30 seconds before trying again On each successive...

Page 55: ...name the value must be a legal Internet host name for example remotemanager digi com Parameter range 0 128 ASCII characters Default 0 0 0 0 P Destination Phone Number Sets or displays the destination...

Page 56: ...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 LA Lookup IP Addres...

Page 57: ...ace baud rate for communication between the device s serial port and the host Parameter range 0x0 0xA standard rates 0x5B9 to 0x5B8D80 non standard rates up to 6 Mb s Parameter Description 0x0 1200 b...

Page 58: ...0x00 RO Packetization Timeout Set or read the number of character times of inter character silence required before transmission begins when operating in Transparent mode Set RO to 0 to transmit charac...

Page 59: ...information Parameter range 0x00 0x05 Parameter Description 0x00 API disabled operate in Transparent mode 0x01 API enabled 0x02 API enabled with escaped control characters 0x03 N A 0x04 N A 0x05 Bypa...

Page 60: ...EQUEST input 3 Reserved 4 Reserved 5 Reserved Default 1 D9 DIO9 ON_SLEEP The DIO9 ON_SLEEP pin configuration pin 13 Parameter range 0 1 3 5 Parameter Description 0 Disabled 1 ON SLEEP output 3 Reserve...

Page 61: ...26 C and 0xF6 10 C Parameter range This is a read only parameter Default N A SM Sleep Mode Sets or reads the sleep mode of the device The sleep mode determines how the device enters and exits a power...

Page 62: ...tion commands CC Command Sequence Character The character value the device uses to enter Command mode The default value 0x2B is the ASCII code for the plus character You must enter it three times with...

Page 63: ...he firmware version on a device The firmware version returns four hexadecimal values 2 bytes ABCD Digits ABC are the main release number and D is the revision number from the main release B is a varia...

Page 64: ...the cyclic redundancy check CRC of the current AT command configuration settings Parameter range 0 0xFFFFFFFF Default N A Diagnostic interface commands The following AT commands are diagnostic interf...

Page 65: ...o 0xFF when P Destination Phone Number is changed The following table provides the parameter s meaning when IP 0 for UDP connections Parameter Description 0x00 The socket is open 0x01 Tried to send bu...

Page 66: ...n 0xFF No known status The following table provides the parameter s meaning when IP 2 for SMS connections Parameter Description 0x00 SMS successfully sent 0x01 SMS failed to send 0x02 Invalid SMS para...

Page 67: ...e in memory until the next time Internet connectivity is established AN is not case sensitive AN may return an APN that matches everything except the case this is acceptable and is not an error Parame...

Page 68: ...AT commands Execution commands Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 68 Default N A...

Page 69: ...Operate in API mode API frame specifications 70 Calculate and verify checksums 72 Frame descriptions 73 Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 69...

Page 70: ...he checksum fails the device discards the frame API operation AP parameter 1 We recommend this API mode for most applications The following table shows the data frame structure when you enable this mo...

Page 71: ...erfering bytes 0x7E 0x00 0x02 0x23 0x11 0xCB 0x11 needs to be escaped which results in the following frame 0x7E 0x00 0x02 0x23 0x7D 0x31 0xCB Note In the previous example the length of the raw data ex...

Page 72: ...helps test data integrity It is calculated by taking the hash sum of all the API frame bytes that came before it except the first three bytes start delimiter and length Calculate and verify checksums...

Page 73: ...The following table provides the contents of the frame For details on frame structure see API frame specifications Field name Field value Data type Description Frame type 0x08 Byte Frame ID Byte Iden...

Page 74: ...r queries immediately and not does not queue them 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 f...

Page 75: ...ed States Format The following table provides the contents of the frame For details on frame structure see API frame specifications Field name Field value Data type Description Frame type 0x1F Byte Fr...

Page 76: ...ference identifier used to match status responses 0 disables the TX Status frame Destination address 32 bit big endian Destination port 16 bit big endian Source port 16 bit big endian UDP or TCP port...

Page 77: ...etails on frame structure see API frame specifications Field name Field value Data type Description Frame type 0x88 Byte Frame ID Byte Identifies the data frame for the host to correlate with a subseq...

Page 78: ...rame ID specified in a previous transmit frame Status Byte Status code see the table below The following table shows the SMS status codes Code Description 0x0 Successful transmit 0x21 Failure to trans...

Page 79: ...specific conditions Format The following table provides the contents of the frame For details on frame structure see API frame specifications Field name Field value Data type Description Frame type 0x...

Page 80: ...me when it receives an SMS message Format The following table provides the contents of the frame For details on frame structure see API frame specifications Field name Field value Data type Descriptio...

Page 81: ...Port command Format The following table provides the contents of the frame For details on frame structure see API frame specifications Field name Field value Data type Description Frame type 0xB0 Byte...

Page 82: ...Socket behavior Secure Sockets Layer SSL certificate checking 83 Socket timeouts 83 Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 82...

Page 83: ...ocket connection We will add this support in the future This means that the device cannot authenticate the remote end of the connection Although the connection is encrypted there is no way to verify t...

Page 84: ...s for the XBee Cellular Modem Cannot find the serial port for the device 85 Correct a macOS Java error 86 Unresponsive cellular component in Bypass mode 87 Not on expected network after APN change 88...

Page 85: ...to does not appear Solution 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 det...

Page 86: ...may encounter a Java error Condition When opening XCTU for the first time on a macOS computer you may see the following error Solution 1 Click More info to open a browser window 2 Click Download to g...

Page 87: ...ular component if it becomes unresponsive Condition In Bypass mode the XBee Cellular Modem does not respond to commands Solution 1 Query the AI Association Indication parameter to determine whether th...

Page 88: ...LTE Cat 1 Embedded Modem User Guide 88 Not on expected network after APN change Condition The XBee Cellular Modem is not on the expected network after a change to the AN APN command Solution Send ATN...

Page 89: ...s Modification statement 90 Interference statement 90 Wireless notice 90 FCC Class B digital device notice 91 Labelling requirements for the host device 91 Digi XBee Cellular LTE Cat 1 Embedded Modem...

Page 90: ...utoris e aux deux conditions suivantes 1 l appareil ne doit pas produire de brouillage et 2 l utilisateur de l appareil doit accepter tout brouillage radio lectrique subi m me si le brouillage est sus...

Page 91: ...rom that to which the receiver is connected n Consult the dealer or an experienced radio TV technician for help Labelling requirements for the host device The device shall be properly labelled to iden...

Reviews:

No comments