manualshive.com logo in svg

Digi XBee Cellular LTE Cat 1, Руководство пользователя, Страница: 70 / 91

Поделиться
Скачать
Digi XBee Cellular LTE Cat 1 Скачать руководство пользователя страница 70

Operate in API mode

API frame specifications

Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide

70

API frame specifications

The firmware supports two API operating modes: without escaped characters and with escaped
characters. Use the

AP

command to enable either mode. To configure a device to one of these modes,

set the following

AP

parameter values:

AP command
setting

Description

AP

= 0

Transparent operating mode, UART serial line replacement with API modes
disabled. This is the default option.

AP

= 1

API operation.

AP

= 2

API operation with escaped characters (only possible on UART).

AP

= 3

Reserved, do not use.

AP

= 4

Reserved, do not use.

AP

= 5

Bypass mode. This mode is for direct communication with the underlying chip and
is only for advanced users.

The API data frame structure differs depending on what mode you choose.

The firmware silently discards any data it receives prior to the start delimiter. If the device does not
receive the frame correctly or if the 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 mode:

Frame fields

Byte

Description

Start delimiter

1

0x7E

Length

2 - 3

Most Significant Byte, Least Significant Byte

Frame data

4 - n

API-specific structure

Checksum

n + 1

1 byte

API operation-with escaped characters (AP parameter = 2)

Set API to 2 to allow escaped control characters in the API frame. Due to its increased complexity, we
only recommend this API mode in specific circumstances. API 2 may help improve reliability if the
serial interface to the device is unstable or malformed frames are frequently being generated.

When operating in API 2, if an unescaped 0x7E byte is observed, it is treated as the start of a new API
frame and all data received prior to this delimiter is silently discarded. For more information on using
this API mode, refer to the following knowledge base article:

http://knowledge.digi.com/articles/Knowledge_Base_Article/Escaped-Characters-and-API-Mode-2

The following table shows the structure of an API frame with escaped characters:

Содержание XBee Cellular LTE Cat 1

Страница 1: ...Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 68: ...AT commands Execution commands Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 68 Default N A...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 82: ...Socket behavior Secure Sockets Layer SSL certificate checking 83 Socket timeouts 83 Digi XBee Cellular LTE Cat 1 Embedded Modem User Guide 82...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Страница 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...

Отзывы:

Нет отзывов