XBEE XBXC3 0x54 6.5.10 REVISION 01.202 REVISION 01.202 3 99 0 0x80 0 XBC LTE Cat 1 Global 45000 Cellular configuration and data Clean Shutdown Safely shut down the cellular component before removing power. Performing a shutdown allows the module to unregister from the cellular network and safely store operating parameters. Failure to shut down properly has the potential to result in delays resuming network operation and in some rare instances may result in an unrecoverable module failure. button 4 Phone Number Read the SIM card phone number. 0x none ASCII ICCID Read the ICCID (Integrated Circuit Card Identifier) of the inserted SIM. 0x none ASCII IMEI Read the module IMEI (International Mobile Equipment Identity). 0x none ASCII IMSI Read the IMSI (International Mobile Subscriber Identity) of the inserted SIM. 0x none ASCII Operator Read the network operator on which the module is registered. 0x none ASCII Modem Firmware Version Read the firmware version string of the cellular modem. 0x none ASCII Modem Firmware Revision Read the firmware revision of the cellular modem. 0x none ASCII Cellular Signal Strength Read the absolute value of the current signal strength to the nearest cell tower in dB 0x none Cellular Network Time Read the current network-provided local time of the XBee, in seconds since 2000-01-01 00:00:00 UTC. The value is empty if the time is not known. The value is synchronized with the network approximately once per hour. 0x none Operating Frequency Channel Number Read the (EU)ARFCN (Absolute Radio Frequency Channel Number) of the current cellular network connection. The value is empty if the device is not registered or the frequency is not known. 0x none Operating Access Technology Read the access technology of the current cellular network connection. 0 - GSM 2 - UTRAN 7 - LTE 0x none Access Point Name (APN) Specifies the packet data network that the modem will use for Internet connectivity. This information is provided by your cellular network operator. Hyphen (-) means no APN specified. Asterisk (*) is the wildcard APN. See documentation for more information. - text 100 1 ASCII Username Specifies the username used when authenticating to the cellular network. This setting is write only. A value of a single space character (ASCII 0x20) acts as an empty value. 0x text 30 1 ASCII Password Specifies the password used when authenticating to the cellular network. This setting is write only. A value of a single space character (ASCII 0x20) acts as an empty value. 0x text 30 1 ASCII SIM PIN Specifies the PIN for using a SIM. This setting is write only. A value of a single space character (ASCII 0x20) acts as an empty value. 0x text 8 1 ASCII SIM PUK Specifies the PUK for unlocking a SIM. This setting is write only. A value of a single space character (ASCII 0x20) acts as an empty value. 0x text 8 1 ASCII Carrier Profile Configures the cellular component to select network operator settings (RF bands, packet data config) for various networks. Changes to the value will only take effect on boot. 0 - Autodetect from inserted ICCID(SIM) 1 - No Profile 2 - AT&T 3 - Verizon 0x0 combo Auto-detect No Profile AT&T Verizon Bandmask The bit field used to configure the enabled 4G LTE bands when ATCP is set to 1 (No Profile). Changes to the value will only take effect on boot. NOTE: The actual set of enabled bands will be a subset of this bit field depending on the limitations of the cellular component. Bit 0 - Band 1. Bit 127 - Band 128. 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF number 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF 0x0 Bitfield Operating APN Read the APN value currently configured in the cellular component. none ASCII Airplane Mode When set to 1, the cellular component of the XBee is fully turned off and no access to the cellular network is performed or possible. If set to 2, the cellular component will have its network connection closed and will not attempt to connect to the cellular network. GNSS operations will still be available. 0x0 combo Normal Operation Airplane Mode GNSS Only Mode Antenna Diversity Assign the function of the secondary external antenna. It can be disconnected and unused, it can be used for cellular diversity for better reception, or it can be used to connect an external Bluetooth antenna as well. 1 combo Disconnected Cellular Diversity Bluetooth External Change Network Settings IP Protocol The protocol used for the listening port (ATC0) while the module is in Transparent mode (ATAP = 0). 0 - UDP Communication, 1 - TCP Communication, 2 - SMS Communication, 3 - Reserved, 4 - SSL over TCP Communication 1 combo UDP TCP SMS Reserved TCPSSL TLS Protocol Version The TLS Protocol Version used for the TLS socket. 0 - Reserved, 1 - Reserved, 2 - TLSv1.1, 3 - TLSv1.2, 4 - TLSv1.3 0x3 combo Reserved Reserved TLSv1.1 TLSv1.2 TLSv1.3 SSL/TLS Profile 0 Specifies the SSL/TLS certificate(s) to use in transparent mode (when IP=4) or API mode (frame type 0x20, or frame type 0x23 with profile set to 0). Format: server_cert;client_cert;client_key ;; text 127 1 ASCII SSL/TLS Profile 1 Specifies the SSL/TLS certificate(s) to use for API frame type 0x23 transmissions with profile set to 1. Format: server_cert;client_cert;client_key ;; text 127 1 ASCII SSL/TLS Profile 2 Specifies the SSL/TLS certificate(s) to use for API frame type 0x23 transmissions with profile set to 2. Format: server_cert;client_cert;client_key ;; text 127 1 ASCII IP Client Connection Timeout The IP client connection timeout. If no activity for this timeout then the connection is closed. When set to 0 the connection is closed immediately after data is sent. 0xbb8 number 0xFFFF 0x0 * 100 ms TCP Server Connection Timeout The TCP server connection timeout. If no activity for this timeout then the connection is closed. When set to 0 the connection is closed immediately after data is sent. 0xbb8 number 0xFFFF 0xa * 100 ms Device Options Device Options Bit field. Bit 0 - Enable Remote Manager. Bit 1 - Enable 2G fallback. Bit 2 - VBUS On (for USB direct mode). Bit 4 - Low Voltage Detection. Bit 7 - Enable 3G fallback. Other bits are reserved and must be 0. 0x1 number 0x97 0x0 bitfield Change Remote Manager behavior Remote Manager FQDN Fully Qualified Domain name of Remote Manager Server. my.devicecloud.com text 63 0 ASCII Remote Manager TCP Port Override When set to a non-zero value, will override the default Remote Manager TCP port to the value specified. The defaults are 3197 when unencrypted and 3199 when TLS is enabled. 0x0 number 0xFFFF 0x0 Remote Manager UDP Port Override When set to a non-zero value, will override the default Remote Manager UDP port to the value specified. The default UDP port is 3297 0x0 number 0xFFFF 0x0 Server Send Keepalive Interval The Remote Manager Server Send Keepalive Interval value. The XBee will consider the Remote Manager connection to have failed after 3 missed keepalives. 0x258 number 0x1C20 0xA * 1 s Device Send Keepalive Interval The Remote Manager Device Send Keepalive Interval value. Remote Manager will consider the connection to have failed after 3 missed keepalives. 0x258 number 0x1C20 0xA * 1 s Remote Manager Status Check Interval How often the XBee performs a status check to Remote Manager. 0x5a0 number 0x10e0 0x1 * 1 min Remote Manager Options Device Options Bit field. Bit 0 - Always remain connected through TCP Bit 1 - Secure TCP connection using TLS Bit 2 - Reserved (Set to 1) Other bits are reserved and must be 0. 0x6 number 0x7 0x0 bitfield Remote Manager Idle Timeout Unless MO bit 0 is set, close any TCP connection to Remote Manager after this amount of idle time. 0xA number 0x5A0 0x1 * 1 min SSL/TLS Certificate File Specifies the SSL/TLS Remote Manager certificate. /flash/cert/digi-remote-mgr.pem text 127 1 ASCII Remote Manager Phone Number Phone numbers must be numeric and optionally prefixed with '+' for international dialing, 5 to 20 characters 12029823370 text 20 5 PHONE Remote Manager Service ID A code used to disambiguate Remote Manager when using SMS shared short codes. Use a space character to disable service ID matching. text 4 1 ASCII Remote Manager Description Description of the XBee that is displayed in Remote Manager. 0x20 text 20 1 ASCII Remote Manager Contact Contact information for the XBee that is displayed in Remote Manager. 0x20 text 20 1 ASCII Remote Manager Location Location of the XBee that is displayed in Remote Manager. 0x20 text 20 1 ASCII Health Metric Selection Metrics to report to DRM Bit 0 - Cellular Signal Strength (RSSI, RSRP, RSRQ) Bit 1 - Module Temperature Bit 2 - TCP Application data counters Bit 3 - UDP Application data counters Bit 4 - Link Deactivations counter Bit 5 - Sleep counter Bit 6 - Location data Bit 7 - Serving Cell data Other bits are reserved and must be 0. 0x00 number 0xff 0x00 bitfield Health Metric Reporting Interval How often the XBee reports metrics to Remote Manager. 0x3c number 0xffff 0x1 * 1 min Change Addressing Settings Serial Number High The upper digits of the unique IMEI assigned to this module. 0x none Serial Number Low The lower digits of the unique IMEI assigned to this module. 0x none Module IP Address The IP address of the module. This command is Read Only and is assigned by the mobile network. 0x none IPV4 Destination Phone Number The destination phone number (used for SMS when ATIP = 2). Phone numbers must be numeric and optionally prefixed with '+' for international dialing, 4 to 20 characters) 0000000 text 20 4 PHONE Primary DNS Address IPv4 address of the primary domain name server. 0.0.0.0 none IPV4 Secondary DNS Address IPv4 address of the secondary domain name server. 0.0.0.0 none IPV4 Destination Address The destination IPv4 address (e.g. XXX.XXX.XXX.XXX) or fully qualified domain name (e.g. example.com) 0.0.0.0 text 128 0 ASCII Operating Destination Address The destination IPv4 address currently in use by transparent mode. 0x none IPV4 Destination Port The destination IP port number. 0x2616 number 0xFFFF 0x0 Listening Source Port The listening IP port number for UDP and TCP operations 0x0 number 0xFFFF 0x0 Change module interfacing options Baud Rate The serial interface baud rate for communication between the serial port of the module and the host. Request non-standard baud rates with values above 0x80 using a terminal window and then read the BD parameter to find actual baud rate achieved. 0x3 combo 1200 2400 4800 9600 19200 38400 57600 115200 230400 460800 921600 Parity The parity for the UART. 0x0 combo No Parity Even Parity Odd Parity Stop Bits The number of stop bits for the UART. 0x0 combo One stop bit Two stop bits Packetization Timeout The number of character times of inter-character delay required before transmission begins. Set to zero to transmit characters as they arrive instead of buffering them into one RF packet. 0x3 number 0xFF 0x0 * character times Text Delimiter The text delimiter to be used for transparent mode. Set to zero to disable text delimiter checking 0x0 number 0xFF 0x0 Flow Control Threshold The flow control threshold. De-assert CTS when FT bytes are in the UART receive buffer. 0x681 number 0x82d 0x9d Bytes API Enable The API mode setting. RF Packets received can be formatted into API frames to be sent out the UART. When API is enabled the UART data must be formatted as API frames as transparent mode is disabled. 0x0 combo Transparent Mode API Mode Without Escapes API Mode With Escapes N/A MicroPython REPL Bypass Mode Modify DIO and ADC Options DIO0/AD0 The DIO0/AD0 pin configuration. Options include: Analog to Digital converter, Digital Input and Output, and Cellular Component State Mirroring (Digital Output). 0x0 combo Disabled N/A ADC Digital Input Digital Out, Low Digital Out, High Cellular Component Mirror (Output) DIO1/AD1/SPI_ATTN The DIO1/AD1/SPI_ATTN pin configuration. Options include: SPI_ATTN, Analog to Digital converter, I2C SCL and Digital Input and Output. 0x0 combo Disabled SPI_ATTN ADC Digital Input Digital Out, Low Digital Out, High I2C SCL DIO2/AD2/SPI_SCLK The DIO2/AD2/SPI_SCLK pin configuration. Options include: SPI_SCLK, Analog to Digital converter, Digital Input and Output. 0x0 combo Disabled SPI_SCLK ADC Digital Input Digital Out, Low Digital Out, High N/A MicroPython UART1 RTS DIO3/AD3/SPI_SSEL The DIO3/AD3/SPI_SSEL pin configuration. Options include: SPI Slave Select, Analog to Digital converter, Digital Input and Output. 0x0 combo Disabled SPI Slave Select ADC Digital Input Digital Out, Low Digital Out, High N/A MicroPython UART1 CTS DIO4/SPI_MOSI The DIO4/SPI_MOSI pin configuration. Options include: SPI Slave MOSI, Digital Input and Output. 0x0 combo Disabled SPI MOSI N/A Digital Input Digital Out, Low Digital Out, High N/A MicroPython UART1 TX DIO5/ASSOCIATED_INDICATOR The DIO5/ASSOCIATED_INDICATOR pin configuration. Options include: Associated LED indicator (blinks when associated), Digital Input and Output. 0x1 combo Disabled Assoc. Indicator N/A Digital Input Digital Out, Low Digital Out, High DIO6/RTS The DIO6/RTS pin configuration. Options include: RTS flow control input, Digital Input and Output. 0x0 combo Disable RTS flow control N/A Digital Input Digital Out, Low Digital Out, High DIO7/CTS The DIO7/CTS pin configuration. Options include: CTS flow control output, Digital Input and Output. 0x1 combo Disable CTS flow control N/A Digital Input Digital Out, Low Digital Out, High DIO8/SLEEP_REQUEST The DIO8/SLEEP_REQUEST pin configuration. Options include: Sleep Request input, Digital Input and Output. 0x1 combo Disabled Sleep Request N/A Digital Input Digital Out, Low Digital Out, High DIO9/ON_SLEEP The DIO9/ON_SLEEP pin configuration. Options include: ON/SLEEP Output, Digital Input and Output. 0x1 combo Disabled ON/SLEEP Output N/A Digital Input Digital Out, Low Digital Out, High DIO10 The DIO10/PWM0 pin configuration. Options include: RSSI PWM Output, PWM0 Output, Digital Input, and Output. 0x0 combo Disabled RSSI PWM0 Output PWM0 Output Digital Input Digital Out, Low Digital Out, High USB VBUS DIO11 The DIO11 pin configuration. Options include: - Fan Enable - I2C SDA - Digital Input - Digital Output - PWM 0x0 combo Disabled Temperature Fan Enable PWM1 Output Digital Input Digital Out, Low Digital Out, High I2C SDA USB direct DIO12/SPI_MISO The DIO12/SPI_MISO pin configuration. Options include: SPI Slave MISO, Digital Input and Output. 0x0 combo Disabled SPI MISO N/A Digital Input Digital Out, Low Digital Out, High N/A MicroPython UART1 RX DIO13/DOUT The DIO13/DOUT pin configuration. Options include: Disabled, UART DOUT enabled. 0x1 combo Disabled UART DOUT DIO14/DIN The DIO14/DIN pin configuration. Options include: Disabled, UART DIN enabled. 0x1 combo Disabled UART DIN Pull Direction The resistor pull direction (1=pullup, 0=pull-down) for corresponding I/O lines that are set in PR command. 0x7FFF number 0x7FFF 0x0 bitfield Pull-up/down Resistor Enable The bit field used to configure internal pull-up/down resistors status for I/O lines. 1=internal pull-up/down enabled, 0=no internal pull-up/down. Bit field map: (14)-DIO13/DOUT, (13)-DIO7/CTS, (12)-DIO11, (11)-DIO10, (10)-DIO12, (9)-DIO9/On/nSleep, (8)-DIO5/Assoc., (7)-DIO14/DIN, (6)-DIO8/Sleep_Request, (5)-DIO6/RTS, (4)-DIO0/AD0, (3)-DIO1/AD1, (2)-DIO2/AD2, (1)-DIO3/AD3, (0)-DIO4 0x7FFF number 0x7FFF 0x0 bitfield PWM0 Duty Cycle The duty cycle of PWM0. 0x0 number 0x3FF 0x0 PWM1 Duty Cycle The duty cycle of PWM1. 0x0 number 0x3FF 0x0 Configure I/O Sampling Parameters. Click on + to expand the list of parameters. Temperature The current module temperature in degrees Celsius in 8-bit two's-complement format. For example 0x1A = 26C, and 0xF6 = -10C 0x none Change Bluetooth behavior Bluetooth Enable Configure the module to enable Bluetooth. 0x0 combo Disabled Enabled Bluetooth MAC Address Read the module's EUI-48 Bluetooth MAC address 0x none Bluetooth Identifier The name to include in BLE advertisements. When set to the default value (ASCII space character, 0x20), the name will be the XBee 3 product name. 0x20 text 22 1 ASCII Bluetooth Advertisement Power Level The output power level that will be used for Bluetooth advertisements. 0x3 combo -20 dBm -10 dBm 0 dBm 8 dBm Bluetooth Authentication Configure Bluetooth authentication with a password or an SRP salt/verifier. button 1 Parameters for authenticating Bluetooth API access false SRP Salt 32-bit random value to make attempts to brute force passwords more difficult. 0 text 8 1 HEX SRP Verifier (part 1) Most significant 32 bytes of the 128 byte verifier 0 text 64 1 HEX SRP Verifier (part 2) Second most significant 32 bytes of the 128 byte verifier 0 text 64 1 HEX SRP Verifier (part 3) Third most significant 32 bytes of the 128 byte verifier 0 text 64 1 HEX SRP Verifier (part 4) Least significant 32 bytes of the 128 byte verifier 0 text 64 1 HEX Change GNSS behavior GNSS Options GNSS Options Bit field. Bit 0 - Require 3D Fix if set, 2D Fix if unset Other bits are reserved and must be 0. 0x0 number 0x1 0x0 bitfield Configure Sleep Parameters Sleep Mode In Normal mode the module is always awake. In Pin sleep the module sleeps when the SLEEP_RQ pin is asserted. Cyclic mode sleeps for SP time and wakes for ST time. Cyclic sleep pin wake is the same as cyclic sleep but SleepRq must be active to allow sleep, otherwise the module will stay awake. 0x0 combo Normal Pin sleep N/A N/A Cyclic Sleep Cyclic Sleep Pin Wake Sleep Time The sleep time of the module. In cyclic sleep mode, node will sleep with CTS disabled for the sleep time interval, then wake for the wake time interval. 0x7530 number 0x83d600 0x1 * 10 ms Wake Time The wake time for cyclic sleep modes. 0xea60 number 0x36ee80 0xea60 * 1 ms Change AT Command Mode Behavior Command Sequence Character The character value used to enter command mode. The default value (0x2B) is the ASCII code for the plus ('+') character. It must be entered three times within the guard time to enter command mode. 0x2B number 0xFF 0x0 Recommended: 0x20-0x7F (ASCII) Command Mode Timeout The command mode timeout parameter. If no valid commands have been received within this time period, module returns to Idle Mode from AT Command Mode. 0x64 number 0x1770 0x2 * 100ms Guard Times The required period of silence before, after, and between the Command Mode Characters of the Command Mode Sequence (GT + CC + GT). The period of silence is used to prevent inadvertent entrance into AT Command Mode. 0x3e8 number 0x6d3 0x2 * 1ms Change MicroPython Behavior Python Auto Start Configure the module to automatically run compiled MicroPython bytecode stored in flash. 0x0 combo Disabled Enabled Access voltage readings and manage a minimum allowed operating voltage. XBee VCC Measurement Measure the voltage of the XBee VCC pin. 0x none * 1mV Low Voltage Shutdown Base Threshold The voltage threshold below which the XBee goes into a shutdown mode. This setting is only active when ATDO bit 4 is set. 0xBB8 number 0xC80 0xA28 * 1mV Voltage Low Voltage Shutdown Reset Offset The voltage, offset from the base threshold (AT%L), above which the XBee reboots (recovers) after being in a low voltage shutdown state. This setting is only active when ATDO bit 4 is set. 0xC8 number 0x2BC 0x64 * 1mV Voltage Access Digi Technical Support features Diagnostics Configuration For Digi Technical Support use only. 0x0 number 0xFFFF 0x0 Diagnostics Configuration For Digi Technical Support use only. 0x0 number 0xFFFF 0x0 Access Firmware Version/Information Firmware Version Read the module firmware version number. 0x none Verbose Firmware Version Read the verbose firmware version number. 0x none ASCII Hardware Version Read the module hardware version number. 0x none Association Indication Read the Association status code to monitor association progress. 0x none Network Reject Code Read the last gathered network reject cause code. 0x none Remote Manager Indicator Monitor Remote Manager connectivity. 0=Connected with no TLS or authentication, 1=Before connection to the Internet, 2=Remote Manager connection in progress, 3=Disconnecting from Remote Manager, 4=Not configured for Remote Manager, 5=Connected over TLS, 6=Connected over TLS with authentication 0x none Protocol/Connection Indication Read the Protocol/Connection status code to monitor IP connection (when ATIP = 0 or 1) or SMS send status (when ATIP = 2). 0x none Hardware Series Read the module hardware series number. 0x none Hardware/Firmware Compatibility Specifies what firmware is compatible with this device. Firmware with a compatibility value lower than the value returned by %C cannot be loaded onto the XBee. 0x none Configuration CRC The CRC of the current settings. The purpose of this command is to allow the detection of an unexpected configuration change on a device. After a firmware update this command may return a different value. 0x none HV 1 1 2