Digi XB3-C-A2-UT series Скачать руководство пользователя страница 46

Страница: 46 / 151

Get started with MicroPython

This guide provides an overview of how to use MicroPython with the XBee Smart Modem. For in-depth
information and more complex code examples, refer to the

Digi MicroPython Programming Guide

Continue with this guide for simple examples to get started using MicroPython on the XBee Smart
Modem.

About MicroPython

MicroPython on the XBee Smart Modem

Use XCTU to enter the MicroPython environment

Use the MicroPython Terminal in XCTU

Example: hello world

Example: turn on an LED

Example: code a request help button

Exit MicroPython mode

Other terminal programs

Use picocom in Linux

Digi XBee3 Cellular LTE-M Global Smart Modem User Guide

Содержание XB3-C-A2-UT series

Страница 1: ...Digi XBee3 Cellular LTE M Smart Modem User Guide...

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

Страница 3: ...o server 22 Debugging 23 Connect to the Daytime server 24 Debugging 25 Connect to a TCP IP address 26 Debugging 27 Perform a GET HTTP request 28 Debugging 29 Get started with MQTT 30 Example MQTT conn...

Страница 4: ...tton press 50 Send a text SMS when the button is pressed 52 Add the time the button was pressed 53 Exit MicroPython mode 54 Other terminal programs 54 Tera Term for Windows 54 Use picocom in Linux 55...

Страница 5: ...ting mode 78 Leave Bypass operating mode 79 Restore cellular settings to default in Bypass operating mode 79 USB direct mode 79 Configure the data pins 79 Enable USB direct mode 79 Enable the VBUS opt...

Страница 6: ...Point Name 99 AM Airplane Mode 99 Network commands 100 IP IP Protocol 100 TL SSL TLS Protocol Version 100 TM IP Client Connection Timeout 100 TS IP Server Connection Timeout 101 DO Device Options 101...

Страница 7: ...Command mode options 117 CC Command Sequence Character 117 CT Command Mode Timeout 117 GT Guard Times 117 MicroPython commands 117 PS Python Startup 118 PY MicroPython Command 118 Firmware version inf...

Страница 8: ...or for outgoing TCP and SSL connections 139 Transparent mode behavior for outgoing UDP data 139 Transparent mode behavior for incoming TCP connections 140 Transparent mode behavior for incoming UDP co...

Страница 9: ...re complexity with only 1 antenna required n Integrated MicroPython programmability enables custom scripting directly on the modem n Enhanced with Digi TrustFence security framework n Manage and confi...

Страница 10: ...nce 12 Cellular service 13 Connect the hardware 14 Configure the device using XCTU 15 Send an SMS message to a phone 18 Connect to the ELIZA server 20 Connect to the echo server 22 Connect to the Dayt...

Страница 11: ...mart Modem User Guide 11 Identify the kit contents The Developer s kit includes the following One XBIB U DEV board One 12 V power supply One cellular antenna with U FL connector One Bluetooth Low Ener...

Страница 12: ...XBee3 Cellular LTE M Global Smart Modem User Guide 12 XBIB U DEV reference This picture shows the XBee USB development board and the table that follows explains the callouts in the picture Number Ite...

Страница 13: ...pply 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 indicator Yellow Modem sending serial UART da...

Страница 14: ...the device is powered 3 Connect the antennas to the XBee Smart Modem by aligning the U FL connectors carefully then firmly pressing straight down to seat the connector You should hear a snap when the...

Страница 15: ...e Note If you are on a macOS computer and encounter problems installing XCTU see Correct a macOS Java error Add a device These instructions show you how to add the XBee Smart Modem to XCTU If XCTU doe...

Страница 16: ...les list XCTU displays the current firmware settings for that device 4 On the Configuration toolbar click the Default button to load the default values established by the firmware and click Yes to con...

Страница 17: ...ice using XCTU Digi XBee3 Cellular LTE M Global Smart Modem User Guide 17 5 Click Update A dialog displays update progress Click Show details for details of the firmware update process See How to upda...

Страница 18: ...ed unless the maximum number of characters has been reached Set to zero to disable text delimiter checking Set to D for a carriage return PH Module s SIM phone number Read only The value that represen...

Страница 19: ...nds the message to the destination phone number set by the P command 12 When the phone receives the text you can see that the sender s phone number matches the value reported by the XBee Smart Modem w...

Страница 20: ...M card installed and the antennas connected as described in Connect the hardware 2 Open XCTU and Add a device 3 Click the Configuration working mode button 4 Select a device from the Radio Modules lis...

Страница 21: ...g If you experience problems with the settings in this example you can load the default settings in XCTU 1 On the Configuration toolbar click the Default button to load the default values established...

Страница 22: ...2 43 121 77 The target IP address of the echo server DE Destination Port 0x2329 The target port number of the echo server To communicate with the echo server 1 Ensure that the device is set up correct...

Страница 23: ...pen a serial connection to the device 11 Click in the left pane of the Console log then type in the Console to talk to the echo server The following screenshot provides an example of this chat Debuggi...

Страница 24: ...s has been reached Set to zero to disable text delimiter checking To communicate with the Daytime server 1 Ensure that the device is set up correctly with the SIM card installed and the antennas conne...

Страница 25: ...ype in the Console to query the Daytime server The following screenshot provides an example of this chat Debugging If you experience problems with the settings in this example you can load the default...

Страница 26: ...umber The target port number that the device sends the transmission to This is represented as a hexadecimal value To connect to a TCP IP address 1 Ensure that the device is set up correctly with the S...

Страница 27: ...g If you experience problems with the settings in this example you can load the default settings in XCTU 1 On the Configuration toolbar click the Default button to load the default values established...

Страница 28: ...ype 50 and click the Write button Hexadecimal 50 is 80 in decimal 7 To switch to TCP communication in the IP field select 1 and click the Write button 8 To move into Transparent mode in the AP field s...

Страница 29: ...httpbin org appears in the Console log Debugging If you experience problems with the settings in this example you can load the default settings in XCTU 1 On the Configuration toolbar click the Defaul...

Страница 30: ...Python from https www python org downloads n That you install the pyserial and paho mqtt libraries to the Python environment If you use Python 2 install these libraries from the command line with pip...

Страница 31: ...3 D 0x44 byte 14 I 0x49 byte 15 G 0x47 byte 16 I 0x49 The following table describes the fields in the packet Field name Description Protocol Name The connect packet starts with the protocol name which...

Страница 32: ...a connect packet to a broker and view the response Open XCTU and click the Configuration working mode button 1 Ensure that the device is set up correctly with the SIM card installed and the antennas...

Страница 33: ...ket button in the Send packets dialog The Add new packet dialog appears 12 Enter the name of the data packet Name the packet connect_frame or something similar 13 Click the HEX input tab and type the...

Страница 34: ...ument you passed in digitest this is optional In line 3 the client connects to a public broker in this case m2m eclipse org on port 1883 the default MQTT port or 8883 for MQTT over SSL There are many...

Страница 35: ...e code we n Instantiate a client object with the client ID digi_mqtt_test n Define the callback functions to use upon connection and upon message receipt n Connect to an MQTT broker at m2m eclipse org...

Страница 36: ...INET socket SOCK_STREAM Allow address reuse on socket eliminates some restart errors svrsock setsockopt socket SOL_SOCKET socket SO_REUSEADDR 1 clisock None cliaddr None These are first defined before...

Страница 37: ...start Start the thread main Note This script is a general TCP UART proxy and can be used for other applications or scripts that use the TCP protocol Its functionality is not limited to MQTT Note You c...

Страница 38: ...mart Modem s internet connection 2 Run the publish example from Example send messages publish with MQTT in a third Python instance while the publish script is running you will have three Python script...

Страница 39: ...TTP for integration with the Web while meeting specialized requirements such as multicast support very low overhead and simplicity for constrained environments source CoAP terms When describing CoAP w...

Страница 40: ...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 and click the Configuration working mode button 3 Ad...

Страница 41: ...s specified in the query Click the Close button to terminate the serial connection Example use Python to generate a CoAP message This example illustrates how the CoAP protocol can perform GET POST PUT...

Страница 42: ...ud rate is 9600 b s 7 Type the baud rate and press Enter You must match the device s current baud rate XCTU provides the current baud rate in the BD Baud Rate field In this example you would type 9600...

Страница 43: ...Getting started with the XBee Smart Modem Development Kit Get started with CoAP Digi XBee3 Cellular LTE M Global Smart Modem User Guide 43...

Страница 44: ...section describes how to configure and manage an XBee using Remote Manager For detailed information on using Remote Manager refer to the Remote Manager User Guide available via the Documentation tab i...

Страница 45: ...key and select additional devices 6 Click More in the Devices toolbar and select Update Firmware from the Update category of the More menu The Update Firmware dialog appears 7 Click Browse to select...

Страница 46: ...simple examples to get started using MicroPython on the XBee Smart Modem About MicroPython 47 MicroPython on the XBee Smart Modem 47 Use XCTU to enter the MicroPython environment 47 Use the MicroPyth...

Страница 47: ...oard XBDB or XBIB and connect it to a computer via a USB cable Note MicroPython does not work with SPI The examples in this guide assume n You have XCTU on your computer See Configure the device using...

Страница 48: ...the MicroPython environment To use the MicroPython Terminal 1 Click the Tools drop down menu and select MicroPython Terminal The terminal opens 2 Click Open 3 In the Select the Serial USB port area cl...

Страница 49: ...ed Pin D4 Pin OUT value 0 Makes a pin object set to output 0 One might expect 0 to mean OFF and 1 to mean ON and this is normally the case But the LED we are turning on and off is setup as what is kno...

Страница 50: ...he PDF version as it may not maintain essential indentations 2 In the terminal at the MicroPython prompt type Ctrl E to enter paste mode The terminal displays paste mode Ctrl C to cancel Ctrl D to fin...

Страница 51: ...nto MicroPython using paste mode and then run it Import the Pin module from machine for simpler syntax from machine import Pin Create a pin object for the pin that the button SW2 is connected to dio0...

Страница 52: ...456789 2 After you create this ph variable with your phone number copy the code below and enter it into MicroPython using paste mode and then run it from machine import Pin import network Import netwo...

Страница 53: ...mode and then run it If it returns an error enter your number again as shown in Send a text SMS when the button is pressed With your phone number in memory in the ph variable copy the code below and e...

Страница 54: ...r terminal programs to communicate with the XBee Smart Modem If you use Microsoft Windows follow the instructions for Tera Term if you use Linux follow the instructions for picocom To download these p...

Страница 55: ...not enabled and that extra line feeds are not enabled a In Tera Term click Setup and select Terminal b In the New line area of the Tera Term Serial port setup window click the Receive drop down menu...

Страница 56: ...attaching the XBee Smart Modem check the directory dev for any devices named ttyUSBx where x is a number An easy way to list these is to type ls dev ttyUSB This produces a list of any device with a na...

Страница 57: ...s 58 Cellular RF characteristics 58 Bluetooth RF characteristics 58 Cellular Networking specifications 58 Power requirements 59 Power consumption 59 Electrical specifications 59 Regulatory approvals 6...

Страница 58: ...hipset u blox SARA R410M Form factor Digi XBee 20 pin through hole SIM size 4FF Nano Cellular RF characteristics The following table provides the RF characteristics for the device Specification Value...

Страница 59: ...le provides the power requirements for the device Specification Value Supply voltage 3 3 to 4 3 V Power consumption Specification State Typical current VCC 3 3 V Peak transmit current Bluetooth disabl...

Страница 60: ...ge output low Sinking 3 mA VCC 3 3 V 0 2 VDD_ IO V VOH Voltage output high Sourcing 3 mA VCC 3 3 V 0 8 VDD_IO V I_IN Input leakage current High Z state I O connected to Ground or VDD_IO 0 1 30 nA RPU...

Страница 61: ...Hardware Mechanical drawings 62 Pin signals 62 RSSI PWM 64 SIM card 64 The Associate LED 65 Digi XBee3 Cellular LTE M Global Smart Modem User Guide 61...

Страница 62: ...wings Digi XBee3 Cellular LTE M Global Smart Modem User Guide 62 Mechanical drawings The following figures show the mechanical drawings for the XBee Smart Modem All dimensions are in inches Pin signal...

Страница 63: ...SB D Either Disabled Digital I O 11 or USB D line 8 USB D Direct USB D line 9 DTR SLEEP_RQ DIO8 Either Disabled Pin Sleep Control Line or Digital I O 8 10 GND Ground 11 DIO4 SPI_MOSI Either Disabled D...

Страница 64: ...DIO10 PWM0 Configuration to enable the RSSI pulse width modulation PWM output on the pin If P0 is set to 1 the RSSI PWM pin outputs a PWM signal where the frequency is adjusted based on the received...

Страница 65: ...ot joined to a mobile network Double blink second The last TCP UDP attempt failed If the LED has this pattern you may need to check DI Device Cloud Indicator or CI Protocol Connection Indication for t...

Страница 66: ...Antenna recommendations Antenna placement 67 Digi XBee3 Cellular LTE M Global Smart Modem User Guide 66...

Страница 67: ...Smart Modem User Guide 67 Antenna placement For optimal cellular reception keep the antenna as far away from metal objects and other electronics including the XBee Smart Modem as possible Often small...

Страница 68: ...ns Power supply considerations 69 Minimum connection diagram 69 Heat considerations and testing 69 Heat sink guidelines 71 Add a fan to provide active cooling 72 Digi XBee3 Cellular LTE M Global Smart...

Страница 69: ...y by more than 0 1 V between light load 0 5 W and heavy load 3 W The supply should be inside the supply voltage operating range at startup and should not be allowed to droop lower than 3 2 V during op...

Страница 70: ...the maximum safe ambient temperature for the XBee Smart Modem TMAX amb with the following equation Where TXBee is the steady state temperature of the XBee Smart Modem that you measured during your tes...

Страница 71: ...f 0 080 in to ensure that components on top of the XBee device do not tear through the material when pressure is applied to the heat sink Install the SIM card prior to placement of the heat sink Posit...

Страница 72: ...Bolt down heat sink Bolt down heat sink and fan Sustained operation 235 mA TBD TBD TBD TBD TBD TBD Device awake limited transmissions TBD Updating traffic sign 1 to 10 TBD TBD TBD 85 C Device primari...

Страница 73: ...r connection process Connecting 74 Cellular network 74 Data network connection 74 Data communication with remote servers TCP UDP 74 Disconnecting 74 Digi XBee3 Cellular LTE M Global Smart Modem User G...

Страница 74: ...evice receives 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 the data ne...

Страница 75: ...t Modem User Guide 75 1 Sockets are closed cleanly if possible 2 The cellular connection is shut down 3 The cellular component is powered off Note We recommend entering Airplane mode before resetting...

Страница 76: ...des Select an operating mode 77 Transparent operating mode 78 API operating mode 78 Bypass operating mode 78 USB direct mode 79 Command mode 80 Digi XBee3 Cellular LTE M Global Smart Modem User Guide...

Страница 77: ...h a logic level asynchronous serial port It uses a UART for serial communication with those devices The XBee Smart Modem supports three operating modes Transparent operating mode API operating mode an...

Страница 78: ...de is an alternative to Transparent and API modes for advanced users with special configuration needs Changes made in this mode might change or disable the device and we do not recommended it for most...

Страница 79: ...ace directly through XBee pins 7 and 8 VBUS functionality is optionally provided on XBee pin 6 if you wish to enable and disable USB mode based on an external source While in USB mode the cellular mod...

Страница 80: ...ilable on the UART interface in both Transparent and API modes You cannot use the SPI interface to enter Command mode Enter Command mode To get a device to switch into this mode you must issue the fol...

Страница 81: ...a parameter value stored in the device s register omit the parameter field The preceding example changes the IP protocol to SMS Multiple AT commands You can send multiple AT commands at a time when th...

Страница 82: ...Modem User Guide 82 Exit Command mode 1 Send CN Exit Command mode followed by a carriage return or 2 If the device does not receive any valid AT commands within the time specified by CT Command Mode T...

Страница 83: ...84 Pin sleep mode 84 Cyclic sleep mode 84 Cyclic sleep with pin wake up mode 84 Airplane mode 84 SPI mode and sleep pin functionality 84 The sleep timer 85 MicroPython sleep behavior 85 Digi XBee3 Cel...

Страница 84: ...rdware flow control the CTS pin asserts low when the device wakes and can receive serial data and de asserts high when the device sleeps Cyclic sleep with pin wake up mode Set SM to 5 to enter Cyclic...

Страница 85: ...ol pin bringing it low only has the effect of preventing the microcontroller from entering low power mode before waking up the device all other sleep preparations such as closing sockets continue as i...

Страница 86: ...d raises OSError ENOTCONN n socket sendto raises OSError ENOTCONN n socket recv returns the empty string the traditional end of file return value n socket recvfrom returns an empty message for example...

Страница 87: ...mmunication Serial interface 88 Serial data 88 UART data flow 88 Serial buffers 89 CTS flow control 89 RTS flow control 89 Enable UART or SPI ports 89 Digi XBee3 Cellular LTE M Global Smart Modem User...

Страница 88: ...st significant bit first and a stop bit high The following diagram illustrates the serial bit pattern of data passing through the device The diagram shows UART data packet 0x1F decimal number 31 as tr...

Страница 89: ...ial flow control is not possible when using the SPI port RTS flow control If you set D6 DIO6 RTS to enable RTS flow control the device does not send data in the serial transmit buffer out the DOUT pin...

Страница 90: ...le UART or SPI ports Digi XBee3 Cellular LTE M Global Smart Modem User Guide 90 If both ports are disabled on reset the device uses the UART in spite of the wrong configuration so that at least one se...

Страница 91: ...I operation SPI communications 92 Full duplex operation 93 Low power operation 94 Select the SPI port 94 Force UART operation 95 Data format 95 Digi XBee3 Cellular LTE M Global Smart Modem User Guide...

Страница 92: ...nication with the slave SPI_ATTN Attention Alerts the master that slave has data queued to send The XBee Smart Modem asserts this pin as soon as data is available to send to the SPI master and it rema...

Страница 93: ...the master When the master is sending data to the slave and the slave has valid data to send in the middle of receiving data from the master it allows a true full duplex operation where data is valid...

Страница 94: ...sleep in SM1 mode Select the SPI port To force SPI mode hold DOUT DIO13 pin 2 low while resetting the device until SPI_ATTN asserts This causes the device to disable the UART and go straight into SPI...

Страница 95: ...ow at reset time DIN CONFIG forces a default configuration on the UART at 9600 baud and brings up the device in Command mode on the UART port You can then send the appropriate commands to the device t...

Страница 96: ...mmands 102 Serial interfacing commands 105 I O settings commands 107 I O sampling commands 115 Sleep commands 116 Command mode options 117 MicroPython commands 117 Firmware version information command...

Страница 97: ...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 and performs a reset 100 ms later If you issue FR...

Страница 98: ...ds PH Phone Number Reads the SIM card phone number If PH is blank the XBee Smart Modem is not registered to the network Parameter range N A Default Set by the cellular carrier via the SIM card S ICCID...

Страница 99: ...component Parameter range 0x71 0x33 113 dBm to 51 dBm read only Default N A AN Access Point Name Specifies the packet data network that the modem uses for Internet connectivity This information is pr...

Страница 100: ...TLS protocol version used for the SSL socket If you change the TL value it does not affect any currently open sockets The value only applies to subsequently opened sockets Note Due to known vulnerabi...

Страница 101: ...sables special features on the XBee Smart Modem according to the following table Bit 0 Remote Manager support If the XBee Smart Modem cannot establish a connection with Remote Manager it waits 30 seco...

Страница 102: ...t my devicecloud com Addressing commands The following AT commands are addressing commands SH Serial Number High The upper digits of the unique International Mobile Equipment Identity IMEI assigned to...

Страница 103: ...onal numbers with or without the prefix If you omit and are dialing internationally you need to include the proper International Dialing Prefix for your calling region for example 011 for the United S...

Страница 104: ...mand mode the address is represented as a dotted quad string notation Parameter range Default 0 0 0 0 DE Destination Port Sets or displays the destination IP port number Parameter range 0x0 0xFFFF Def...

Страница 105: ...lowing AT commands are serial interfacing commands BD Baud Rate Sets or displays the serial interface baud rate for communication between the device s serial port and the host Modified interface baud...

Страница 106: ...s Parameter range 0 1 Parameter Configuration 0 One stop bit 1 Two stop bits Default 0 RO Packetization Timeout Set or read the number of character times of inter character silence required before tra...

Страница 107: ...ow control threshold The device de asserts CTS when FT bytes are in the UART receive buffer Parameter range 0x9D 0x82D Default 0x681 AP API Enable The API mode setting The device can format the RF pac...

Страница 108: ...tion 0 Disabled 1 N A 2 Analog input 3 Digital input 4 Digital output default low 5 Digital output default high Default 0 D1 DIO1 AD1 Sets or displays the DIO1 AD1 configuration pin 19 Parameter range...

Страница 109: ...g input 3 Digital input 4 Digital output default low 5 Digital output default high Default 0 D3 DIO3 AD3 Sets or displays the DIO3 AD3 configuration pin 17 Parameter range 0 5 Parameter Description 0...

Страница 110: ...0 Disabled 1 Associated LED 2 N A 3 Digital input 4 Digital output default low 5 Digital output default high Default 1 D6 DIO6 RTS Sets or displays the DIO6 RTS configuration pin 16 Parameter range 0...

Страница 111: ...O8 SLEEP_REQUEST Sets or displays the DIO8 DTR SLP_RQ configuration pin 9 Parameter range 0 1 3 5 Parameter Description 0 Disabled 1 SLEEP_REQUEST input 3 Digital input 4 Digital output default low 5...

Страница 112: ...Description 0 Disabled 1 RSSI PWM0 output 2 PWM0 output 3 Digital input 4 Digital output low 5 Digital output high 6 USB VBUS Default 0 P1 DIO11 PWM1 Configuration Sets or displays the DIO11 configura...

Страница 113: ...range 0 1 3 5 Parameter Description 0 Disabled 1 SPI_MISO 2 N A 3 Digital input 4 Digital output default low 5 Digital output default high Default 0 P3 DIO13 DOUT Sets or displays the DIO13 DOUT conf...

Страница 114: ...ault 0 0x7FFF PR Pull up down Resistor Enable Sets or displays the bit field that configures the internal resistor status for the digital input lines Internal pull up down resistors are not available...

Страница 115: ...put 1 Enable PWM0 output P0 DIO10 PWM0 Configuration 2 2 Apply the settings use CN command or AC Apply Changes The PWM period is 42 62 s and there are 0x03FF 1023 decimal steps within this period When...

Страница 116: ...honors the SLEEP_RQ pin Set D8 DIO8 SLEEP_REQUEST to the sleep request function 1 4 Cyclic Sleep In this mode the device repeatedly sleeps for the value specified by SP and spends ST time awake 5 Cycl...

Страница 117: ...of the Command mode sequence GT CC GT The period of silence prevents inadvertently entering Command mode Parameter range 0 0xFF Default 0x2B the ASCII plus character CT Command Mode Timeout Sets or di...

Страница 118: ...reports details of the stored code In Command mode it returns three lines of text for example source 1662 bytes hash 0xC3B3A813 bytecode 619 bytes hash 0x0900DBCE compiled 2017 05 09T15 49 44 The mes...

Страница 119: ...ersion Reads the firmware version on a device Parameter range 0 0xFFFF read only Default Set in firmware VL Verbose Firmware Version Shows detailed version information including the application build...

Страница 120: ...mode 0x2B USB Direct active 0x2F Bypass mode active 0xFF Initializing Parameter range 0 0xFF read only Default N A DI Device Cloud Indicator Displays the current Remote Manager status for the XBee Ra...

Страница 121: ...erver DNS lookup failed 0x23 Connection lost 0x24 Unknown 0xFF No known status The following table provides the parameter s meaning when IP 1 or 4 for TCP connections Parameter Description 0x00 The so...

Страница 122: ...t AT command configuration settings Parameter range 0 0xFFFFFFFF Default N A Execution commands The location where most AT commands set or query register values execution commands execute an action on...

Страница 123: ...ital I O and are included in the digital data value below Pins D0 D9 are bits 0 9 and P0 P2 are bits 10 12 n Analog channel mask The bits set to 1 are configured for analog I O and have individual rea...

Страница 124: ...Operate in API mode API mode overview 125 Use the AP command to set the operation mode 125 API frame format 125 Frame descriptions 129 Digi XBee3 Cellular LTE M Global Smart Modem User Guide 124...

Страница 125: ...to filter out additional API frames with unknown frame types into your software interface Use the AP command to set the operation mode Use AP API Enable to specify the operation mode AP command settin...

Страница 126: ...formation on using this API mode see the Escaped Characters and API Mode 2 in the Digi Knowledge base API escaped operating mode works similarly to API mode The only difference is that when working in...

Страница 127: ...re the same as the non escaped frame Start delimiter Length Frame type Frame Data Checksum Data 7E 00 0F 17 01 00 7D 33 A2 00 40 AD 14 2E FF FE 02 4E 49 6D The length field has a two byte value that s...

Страница 128: ...dentifier 01 API frame ID 50 01 Destination address low 00 Option byte 48 65 6C 6C 6F Data packet B8 Checksum To calculate the check sum you add all bytes of the packet excluding the frame delimiter 7...

Страница 129: ...ormat 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 Frame type 0x08 Byte Frame ID Byte Identif...

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

Страница 131: ...it big endian If the source port is 0 the device attempts to send the frame data using an existing open socket with a destination that matches the destination address and destination port fields of th...

Страница 132: ...For details on frame structure see API frame format 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 subsequen...

Страница 133: ...ame ID specified in a previous transmit frame Status Byte Status code see the table below The following table shows the status codes Code Description 0x0 Successful transmit 0x21 Failure to transmit t...

Страница 134: ...to specific conditions 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 Frame type 0x8A By...

Страница 135: ...ceive RX Packet IPv4 0xB0 Description The XBee Smart Modem uses this frame when it receives RF data on a network socket that is created by a TX request frame or configuring C0 Source Port Format The f...

Страница 136: ...outgoing UDP data 138 API mode behavior for incoming TCP connections 138 API mode behavior for incoming UDP data 139 Transparent mode behavior for outgoing TCP and SSL connections 139 Transparent mode...

Страница 137: ...Timeout or when the socket is closed via a TX request with the CLOSE flag set Enable incoming TCP sockets in API mode In API mode you can enable incoming connections to the XBee Smart Modem 1 To enabl...

Страница 138: ...be closed after use or 2 You must use the socket specified by the C0 Source Port setting To use the socket specified by the C0 setting in the Transmit TX request frame use a source port that matches t...

Страница 139: ...espectively as the destination address destination port and source port fields for the Transmit TX Request frame Transparent mode behavior for outgoing TCP and SSL connections Note SSL is not currentl...

Страница 140: ...ctions When the IP setting is TCP and there is no existing connection to or from the XBee Smart Modem the device accepts one incoming connection Any data received on the connection is sent out the XBe...

Страница 141: ...he XBee Smart Modem Cannot find the serial port for the device 142 Correct a macOS Java error 144 Unresponsive cellular component in Bypass mode 145 Syntax error at line 1 145 Network connection issue...

Страница 142: ...ck 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 4 Remove the development boa...

Страница 143: ...Cellular LTE M Global Smart Modem User Guide 143 1 If you accidentally have the loopback pins jumpered 2 You may not be using an updated FTDI driver a This may require you to reboot your computer b Di...

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

Страница 145: ...r at line 1 You may get a syntax error at line 1 error after pasting example MicroPython code and pressing Ctrl D Solution This commonly happens when you accidentally type a character at the beginning...

Страница 146: ...es Digi XBee3 Cellular LTE M Global Smart Modem User Guide 146 1 Enter Bypass operating mode 2 Type at cgdcont 1 IP APN String and press Enter For example for this early adopter kit at cgdcont 1 IP vz...

Страница 147: ...Regulatory information United States FCC 148 IC Industry Canada 150 Digi XBee3 Cellular LTE M Global Smart Modem User Guide 147...

Страница 148: ...r use with other products without any further certification as per FCC section 2 1091 Modifications not expressly approved by Digi could void the user s authority to operate the equipment IMPORTANT OE...

Страница 149: ...uetooth radio Integral antenna Part number Type description Gain Application 31000020 02 Integral antenna 2 5 dBi Fixed Mobile Dipole antennas Part number Type description Gain Application 29000095 Di...

Страница 150: ...ub B and Industry Canada accepts FCC test report or CISPR 22 test report for compliance with ICES 003 This device complies with Industry Canada licence exempt RSS standard s Operation is subject to th...

Страница 151: ...up rieur au gain maximal indiqu sont strictement interdits pour l exploitation de l metteur Detachable Antenna Under Industry Canada regulations this radio transmitter may operate using only an antenn...

Результаты поиска

Содержание XB3-C-A2-UT series

Отзывы:

Digi XB3-C-A2-UT series, Руководство пользователя, Страница: 46 / 151

Результаты поиска

Содержание XB3-C-A2-UT series

Отзывы: