1. Manuals
  2. Brands
  3. Digi Manuals
  4. Control Unit
  5. XBee3 802.15.4
  6. User manual

Digi XBee3 802.15.4 User Manual

Radio frequency (rf) module
Hide thumbs Also See for XBee3 802.15.4:
Table of Contents

Advertisement

Quick Links

Download this manual
Digi XBee3® 802.15.4
Radio Frequency (RF) Module
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XBee3 802.15.4 and is the answer not in the manual?

Questions and answers

Related Manuals for Digi XBee3 802.15.4

Summary of Contents for Digi XBee3 802.15.4

  • Page 1 Digi XBee3® 802.15.4 Radio Frequency (RF) Module User Guide...
  • Page 2 Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
  • Page 3 To provide feedback on this document, email your comments to techcomm@digi.com Include the document title and part number (Digi XBee3® 802.15.4 RF Module User Guide, 90002273 B) in the subject line of your email. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 4: Table Of Contents

    Change the firmware protocol Regulatory information Get started Verify kit contents Assemble the hardware Plug in the XBee3 802.15.4 RF Module Unplug an XBee3 802.15.4 RF Module Configure the device using XCTU Configure remote devices Configure the devices for a range test Perform a range test Configure the XBee3 802.15.4 RF Module...
  • Page 5 Example: Remote AT command in API mode Digital I/O change detection I/O line passing Digital line passing Example: Digital line passing Analog line passing Example: Analog line passing Output sample data Output control I/O behavior during sleep Digital I/O lines Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 6 Sleep support Sleep modes Pin Sleep mode (SM = 1) Cyclic Sleep mode (SM = 4) Cyclic Sleep with Pin Wake-up mode (SM = 5) Sleep parameters Sleep current Sleep pins Sleep conditions Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 7 EC (CCA Failures) Sleep settings commands SM command SP command ST command DP (Disassociated Cyclic Sleep Period) SO command FP (Force Poll) UART interface commands BD command NB command SB command FT command RO command Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 8 AV (Analog Voltage Reference) IT (Samples before TX) IF command IO command I/O line passing commands IA (I/O Input Address) IU command T0 command T1 command T2 command T3 command T4 command T5 command Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 9 RX Packet: 16-bit address I/O frame - 0x83 AT Command Response frame - 0x88 TX Status frame - 0x89 Modem Status frame - 0x8A Transmit Status frame - 0x8B Receive Packet frame - 0x90 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 10 Create the Image Notify request Query Next Image request Query Next Image response Image Block request Image Block response Upgrade End request Upgrade End response OTA error handling Default response commands Upgrade End Request error statuses Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 11: Digi Xbee3® 802.15.4 Rf Module User Guide

    The devices require minimal power and provide reliable delivery of data between devices. The devices operate within the ISM 2.4 GHz frequency band. The XBee3 802.15.4 RF Module uses XBee3 hardware and the Silicon Labs EFR32 chipset. As the name suggests, the 802.15.4 module is over-the-air compatible with our Legacy 802.15.4 modules (S1 and S2C hardware).

  • Page 12: Applicable Firmware And Hardware

    Digi XBee3® 802.15.4 RF Module User Guide Applicable firmware and hardware Applicable firmware and hardware This manual supports the following firmware: 802.15.4 version 20xx It supports the following hardware: XBee3 Change the firmware protocol You can switch the firmware loaded onto the XBee3 hardware to run any of the following protocols: Zigbee 802.15.4...
  • Page 13 This section covers the following tasks and features: Verify kit contents Assemble the hardware Configure the device using XCTU Configure remote devices Configure the devices for a range test Perform a range test Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 14: Get Started

    Get started Verify kit contents Verify kit contents The XBee3 802.15.4 RF Module development kit contains the following components: Part XBee3 Zigbee SMT module (3) XBee Grove development board (3) Micro USB cable (3) Antenna - 2.4 GHz, half-wave dipole, 2.1 dBi, U.FL female, articulating...

  • Page 15: Plug In The Xbee3 802.15.4 Rf Module

    Follow these steps to connect the XBee devices to the boards included in the kit: 1. Plug one XBee3 802.15.4 RF Module into each XBee Grove Development Board. When you connect the development board to a PC for the first time, the PC automatically installs drivers, which may take a few minutes to complete.

  • Page 16: Unplug An Xbee3 802.15.4 Rf Module

    XBee3 802.15.4 RF Module. CAUTION! Make sure the board is not powered when you remove the XBee3 802.15.4 RF Module.
  • Page 17 9. Click the Write radio settings button The remote XBee device now has a different LED blink time. 10. To return to the default LED blink times, change the LT parameter back to 0 for XBEE_B. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 18: Configure The Devices For A Range Test

    8. Disconnect REMOTE_DEVICE from the computer, remove it from XCTU, and connect it to a power supply, laptop, or portable battery. 9. Leave LOCAL_DEVICE connected to the computer. Perform a range test 1. Go to the XCTU display for radio 1. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 19 Get started Perform a range test 2. Click to discover remote devices within the same network. The Discover remote devices dialog appears. 3. Click Add selected devices. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 20 5. Change the Range Test type to Loopback. 6. In the Select the local radio device area, select radio 1. XCTU automatically selects the Discovered device option, and the Start Range Test button is active. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 21 XCTU prompts you to enable the loopback jumper. Plug in the XBee3 802.15.4 RF Module has pictures that show the jumper in the UART position—move the jumper to the left on the surface-mount device or down on the through- hole device puts it in loopback mode If the test is running properly, the packets sent should match the packets received.
  • Page 22 BR (data rate) parameter on both radios. When the test is complete, click Stop Range Test. XCTU displays another loopback jumper warning screen reminding you to put the loopback jumper back in its original position. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 23 Get started Perform a range test Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 24: Configure The Xbee3 802.15.4 Rf Module

    Configure the XBee3 802.15.4 RF Module Software libraries Over-the-air (OTA) firmware update Custom defaults XBee Network Assistant Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 25: Software Libraries

    Configure the XBee3 802.15.4 RF Module Software libraries Software libraries One way to communicate with the XBee3 802.15.4 RF Module is by using a software library. The libraries available for use with the XBee3 802.15.4 RF Module include: XBee Java library XBee Python library The XBee Java Library is a Java API.

  • Page 26: Xbee Network Assistant

    Configure the XBee3 802.15.4 RF Module XBee Network Assistant Setting a custom default that has already been set or setting a custom default to the factory default value will not reclaim the space used by the previous value. The new value takes effect but the old value still occupies space in memory, reducing the number of custom defaults that can be set.

  • Page 27: Modes

    Modes Transparent operating mode API operating mode Command mode Idle mode Transmit mode Receive mode Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 28: Transparent Operating Mode

    AT commands. When you want to read or set any parameter of the XBee3 802.15.4 RF Module using this mode, you have to send an AT command. Every AT command starts with the letters AT followed by the two characters that identify the command and then by some optional configuration values.

  • Page 29: Enter Command Mode

    Every AT command starts with the letters AT, which stands 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, omit the parameter field. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 30: Response To At Commands

    AT command parameters. Valid formats for hexidecimal values include with or without a leading 0x for example FFFF or 0xFFFF. Response to AT commands When using AT commands to set parameters the XBee3 802.15.4 RF Module responds with OK<cr> if successful and ERROR<cr> if not. Apply command changes Any changes you make to the configuration command registers using AT commands do not take effect until you apply the changes.

  • Page 31: Idle Mode

    Receive mode This is the default mode for the XBee3 802.15.4 RF Module. The device is in Receive mode when it is not transmitting data. If a destination node receives a valid RF packet, the destination node transfers the data to its serial transmit buffer.

  • Page 32: Serial Communication

    Serial communication Serial interface Serial receive buffer Serial transmit buffer UART data flow Flow control Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 33: Serial Interface

    UART data flow Devices that have a UART interface connect directly to the pins of the XBee3 802.15.4 RF Module as shown in the following figure. The figure shows system data flow in a UART-interfaced environment.

  • Page 34: Flow Control

    Flow control For serial communication to occur, you must configure the UART of both devices (the microcontroller and the XBee3 802.15.4 RF Module) with compatible settings for the baud rate, parity, start bits, stop bits, and data bits. Each data byte consists of a start bit (low), 8 data bits (least significant bit first) and a stop bit (high).

  • Page 35: Rts Flow Control

    2. If the host does not allow the device to transmit data out from the serial transmit buffer due to being held off by hardware flow control. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 36: Spi Operation

    This section specifies how SPI is implemented on the device, what the SPI signals are, and how full duplex operations work. SPI communications Full duplex operation Low power operation Select the SPI port Force UART operation Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 37: Spi Communications

    SPI communications SPI communications The XBee3 802.15.4 RF Module supports SPI communications in slave mode. Slave mode receives the clock signal and data from the master and returns data to the master. The following table shows the signals that the SPI port uses on the device.

  • Page 38: Full Duplex Operation

    Full duplex operation Full duplex operation When using SPI on the XBee3 802.15.4 RF Module the device uses API operation without escaped characters to packetize data. The device ignores the configuration of AP because SPI does not operate in any other mode. SPI is a full duplex protocol, even when data is only available in one direction.

  • Page 39: Select The Spi Port

    If you configure a device with only the SPI enabled and no SPI master is available to access the SPI slave port, you can recover the device to UART operation by holding DIN / CONFIG low at reset time. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 40 Command mode on the UART port. You can then send the appropriate commands to the device to configure it for UART operation. If you write those parameters, the device comes up with the UART enabled on the next reset. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 41: I/O Support

    Monitor I/O lines I/O sample data format API frame support On-demand sampling Periodic I/O sampling Digital I/O change detection I/O line passing Digital line passing Output sample data Output control I/O behavior during sleep Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 42: Legacy Support

    I/O support Legacy support Legacy support By default, the XBee3 802.15.4 RF Module is configured to operate in a legacy configuration. This provides network and application compatibility with XBee S1 802.15.4 and XBee S2C 802.15.4 devices. Use AO command to determine which outgoing API frames are emitted and what I/O lines are used for sampling.

  • Page 43: Mixed Network Considerations

    If you use a mixed network of XBee3 and legacy S1 or S2C devices, you must set AO to 2 in order to transmit sample data that is compatible with these devices. Regardless of the AO setting, if an XBee3 802.15.4 RF Module receives an I/O sample packet from an S1 or S2C device, it always outputs the legacy data format.

  • Page 44: Analog I/O Support

    2-byte value. For a 10-bit ADC, the acceptable range is from 0x0000 to 0x03FF. To convert this value to a useful voltage level, apply the following formula: ADC / 1023 (vREF) = Voltage Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 45: Monitor I/O Lines

    Regardless of how I/O data is generated, the format of the sample data is always represented as a series of bytes in the following format which is compatible with the S1 802.15.4 and S2C 802.15.4 devices: Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 46 AD0 and continues sequentially for each enabled analog input channel up to AD3. If the analog portion of the channel mask is 0, then no analog sample bytes are included. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 47: Enhanced Data Format

    If the analog channel mask is 0x00, then no analog sample bytes is included. API frame support I/O samples generated using Periodic I/O sampling (IR) and Digital I/O change detection (IC) are transmitted to the destination address specified by DH and DL. In order to display the sample data, Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 48: On-Demand Sampling

    API mode (AP = 1 or 2). The sample data is represented as an I/O sample API frame. There are three types of I/O sample frames that are supported by the XBee3 802.15.4 RF Module: 0x92 - Enhanced I/O sample frame...

  • Page 49: Example: Local At Command In Api Mode

    Indicates the AT command that this response corresponds to 0x49 0x53 = IS Status Indicates success or failure of the AT command 00 = OK if no I/O lines are enabled, this will return 01 (ERROR) Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 50: Example: Remote At Command In Api Mode

    Indicates the AT command that this response corresponds to 0x49 0x53 = IS Command Status Indicates success or failure of the AT command 00 = OK if no I/O lines are enabled, this will return 01 (ERROR) Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 51: Periodic I/O Sampling

    IT (Samples before TX) specifies how many I/O samples can be transmitted in a single OTA packet. Any single-byte value (0 - 0xFF) is accepted for input. However, the value is adjusted downward based on Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 52: Example: Remote At Command In Api Mode

    Mask which indicates which digital and analog lines are enabled. Even though mask multiple samples are being gathered, there will only ever be one channel mask per frame. (0x0604 = 0000 0110 0000 0100b = ADC0, ADC1, DIO3) Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 53: Digital I/O Change Detection

    In the top graph, the humps indicate that the sample was not taken at that exact moment and needed to wait for the next IR sample period. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 54: I/O Line Passing

    Digital line passing is only available on pins D0 through P3. You cannot use UART and SPI pins for line passing. Example: Digital line passing A sampling XBee3 802.15.4 RF Module is configured with the following settings: AT command Parameter value D2 command...

  • Page 55: Analog Line Passing

    When this device receives an incoming I/O sample, if the source address matches the one set by IA, the device sets the PWM output of P0 to match the ADC input of D0 of the receiver. This output level holds for thirty seconds before the pin returns to a digital output low state. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 56: Output Sample Data

    PWM output pins set by analog line passing are shutdown during sleep and revert to their preset values (M0 and M1) on wake. This happens regardless of whether the timeout has expired or not. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 57: Networking

    Networking terms MAC Mode configuration Clear Channel Assessment (CCA) Retries configuration Transmit status based on MAC mode and XBee retries configurations Addressing Peer-to-peer networks Master/slave networks Direct and indirect transmission Encryption Maximum payload Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 58: Networking Terms

    Medium Access Control (MAC) Mode configures two functions: 1. Enables or disables the use of a Digi header in the 802.15.4 RF packet. When the Digi header is enabled (MM = 0 or 3), duplicate packet detection is enabled as well as certain AT commands.

  • Page 59: Clear Channel Assessment (Cca)

    This is enabled by default and provides a minimal amount of reliability to unicast transmissions. If you are operating in a MAC Mode that enables the Digi header (MM=0 or MM=3), then you can optionally include Application-Layer retries using the RR command command.

  • Page 60: Transmit Status Based On Mac Mode And Xbee Retries Configurations

    The tables also report the transmit status reported when the device detects energy above the CCA threshold (when a CCA failure happens). The following table applies in either of these cases: Digi header is disabled. Digi header is enabled and XBee Retries (RR parameter) is equal to 0 (default configuration). CCA failure Destination reachable Destination unreachable...

  • Page 61: Addressing

    Every RF data packet sent over-the-air contains a Source Address and Destination Address field in its header. The XBee3 802.15.4 RF Module conforms to the 802.15.4 specification and supports both short 16-bit addresses and long 64-bit addresses. A unique 64-bit IEEE source address is assigned at the factory and can be read with the SL (Serial Number Low) and SH (Serial Number High) commands.

  • Page 62: Peer-To-Peer Networks

    Peer-to-peer networks Peer-to-peer networks By default, XBee3 802.15.4 RF Modules are configured to operate within a peer-to-peer network topology and therefore are not dependent upon master/slave relationships. Our peer-to-peer architecture features fast synchronization times and fast cold start times. This default configuration accommodates a wide range of RF data applications.

  • Page 63: Coordinator Association

    If A2 bit 0 is set, the coordinator performs an active scan. The active scan process sends a beacon request to the broadcast address (0xFFFF) and the broadcast PAN ID (0xFFFF) and listens for beacons responses. This process is repeated for each channel specified in SC. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 64: Association Indicators

    API mode, or as a remote command. Modem status messages Not all device status messages are related with association, but for completeness all device status types reported by XBee3 802.15.4 RF Module are listed in the following table. Type Meaning 0x00 Hardware reset.

  • Page 65: Association Indicator Status Codes

    Coordinator formed a new network. 0x0D Input voltage is too high, which prevents transmissions. Association indicator status codes The XBee3 802.15.4 RF Module can potentially give any of the status codes in response to AI command in the following table.

  • Page 66: Configure An Indirect Messaging Coordinator

    It is more difficult to use indirect messaging with pin sleep than with cyclic sleep because the end device must wake up periodically to poll for the data from the coordinator. Otherwise, the coordinator Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 67: Encryption

    ENC-MIC-64 ENC-MIC-128 Yes The XBee3 802.15.4 RF Module only supports security levels 0 and 4. It does not support message integrity checks. EE 0 selects security level 0 and EE 1 selects security level 4. When using encryption, all devices in the network must use the same 16-byte encryption key for valid data to get through.

  • Page 68: Maximum Payload

    4. If you are using the long source address (MY = 0xFFFE), the maximum achievable payload is reduced by 6 bytes (size of long address (8) - size of short address (2) = 6). Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 69: Maximum Payload Summary Tables

    The XBee/XBee-PRO S2C 802.15.4 and XBee3 802.15.4 RF Modules enhance transmission by implementing a transmission queue that allows the device to transmit to several devices at the same time.
  • Page 70 The sender is an XBee3 802.15.4 RF Module, and the receiver is a Legacy 802.15.4 module. The sender has the Digi header enabled (MM = 0 or 3) and RR (XBee Retries) > 0. The sender sends broadcast and unicast messages at the same time to the Legacy 802.15.4 module without waiting for the transmission status of the previous packet.

  • Page 71: Network Commissioning And Diagnostics

    To accommodate these requirements, modules include features to aid in placing devices, configuring devices, and network diagnostics. Remote configuration commands Node discovery Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 72: Remote Configuration Commands

    ID in the remote command request is set to 0 , indicating that the request is sent without acknowledgment. Node discovery Node discovery has three variations as shown in the following table: Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 73: About Node Discovery

    Directed node discovery in compatibility mode The behavior of the Legacy 802.15.4 module (S1 hardware) varies with the default behavior described above for the directed node discovery command. The Legacy module does not complete the command Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 74: Destination Node

    DH/DL is set to that short address (with DH at 0 and DL set to the value of MY). If the responding node has a long address (MY is 0xFFFE), then DH/DL are set to the SH/SL of the responding node. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 75: Sleep Support

    In order to increase battery life, the device sleeps, which means it stops operating. It can be woken by a timer expiration or a pin. Sleep modes Sleep parameters Sleep current Sleep pins Sleep conditions Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 76: Sleep Modes

    The Cyclic Sleep modes allow devices to periodically check for RF data. When the SM parameter is set to 4, the XBee3 802.15.4 RF Module is configured to sleep, then wakes once per cycle to check for data from a coordinator. The Cyclic Sleep Remote sends a poll request to the coordinator at a specific interval set by the SP (Cyclic Sleep Period) parameter.

  • Page 77: Cyclic Sleep With Pin Wake-Up Mode (Sm = 5)

    SM command SP command ST command DP (Disassociated Cyclic Sleep Period) SO command Sleep current The following table shows the sleep current during the XBee3 802.15.4 RF Module sleep modes. Sleep mode Sleep current SM command setting Pin sleep Cyclic sleep <1 µA @ 25 ºC...

  • Page 78: Sleep Conditions

    In addition, the wake time is extended by an additional ST time when new OTA data or serial data is received. 2. Sleep Request pin is not asserted when operating in pin sleep mode 3. Data is waiting to be sent OTA. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 79 UART interface commands Command mode options UART pin configuration commands SPI interface commands I/O settings commands I/O sampling commands I/O line passing commands Diagnostic commands - firmware/hardware information Memory access commands Custom default commands Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 80: Network And Security Commands

    Sets or displays the operational compatibility with the Legacy 802.15.4 device (S1 hardware). This parameter should only be set when operating in a mixed network that contains XBee Series 1 devices. Parameter range 0 - 3 Bit field: Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 81 Default This bit does not typically need to be set. However, when the XBee3 802.15.4 RF Module is streaming broadcasts in transparent mode to a Legacy 802.15.4 module (S1 hardware), and RR > 0, set this bit to avoid a watchdog reset on the Legacy 802.15.4 module.

  • Page 82: Ni Command

    For more information about the options that affect the behavior of the ND command, see command. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 83: Dn Command

    ND (Node Discover) command. The NT value is transmitted along with the ND command; remote nodes set up a random hold-off time based on this timeout. Once the ND command has ended, the base discards any responses it receives. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 84: No Command

    The MAC Mode serves two purposes: Enable/disable the use of a Digi header, which enables advanced features. Enable/disable MAC-Layer acknowledgments. The default configuration enables a Digi-specific header to every RF packet. This header includes information that allows for some advanced features: Network discovery support...

  • Page 85: Np Command

    The following commands configure the device for a master/slave 802.15.4 network. CE command The routing mode of the XBee3 802.15.4 RF Module. The XBee3 802.15.4 RF Module does not allow association until bit 2 of A2 (Coordinator Association) set. Parameter range...

  • Page 86: A2 (Coordinator Association)

    It operates on the channel determined by the CH parameter. Channel reassignment Coordinator performs an Energy Scan to find the quietest channel out of the channels to be scanned determined by the SC parameter. The Coordinator then operates on that channel. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 87: Sc Command

    Channel 16 (0x10) Channel 17 (0x11) Channel 18 (0x12) Channel 19 (0x13) Channel 20 (0x14) Channel 21 (0x15) Channel 22 (0x16) Channel 23 (0x17) Channel 24 (0x18) Channel 25 (0x19) Channel 26 (0x1A) Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 88: Force Disassociation)

    The following commands affect the source and destination addressing for the device. SH command Displays the upper 32 bits of the unique IEEE 64-bit extended address assigned to the XBee in the factory. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 89: Sl Command

    This destination address is also used for outgoing I/O samples in both Transparent and API modes. To transmit using a 16-bit address, set DH to 0 and DL less than 0xFFFF. 0x000000000000FFFF is the broadcast address (DH = 0, DL = 0xFFFF). Parameter range 0 - 0xFFFFFFFF Default Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 90: Dl Command

    The RR value does not need to be set on all devices for retries to work. If retries are enabled, the transmitting device sets a bit in the Digi RF Packet header that requests the receiving device to send an ACK. If the transmitting device does not receive an ACK within 200 ms, it re-sends the packet within a random period up to 48 ms.

  • Page 91: Security Commands

    Set this command parameter the same on all devices in a network. The entire payload of the packet is encrypted using the key and the CRC is computed across the ciphertext. Parameter range 128-bit value (up to 16 bytes) Default Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 92: Rf Interfacing Commands

    The CA parameter is measured in units of -dBm. The CCA threshold is set upon device initialization, any change to the CCA threshold must be written to flash with the WR command and the module reset (power cycle or FR command) before the new threshold is observed. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 93: Rn Command

    For example, if DB returns 0x60, then the RSSI of the last packet received was -96 dBm. If the XBee3 802.15.4 RF Module has been reset and has not yet received a packet, DB reports 0. This value is volatile (the value does not persist in the device's memory after a power-up sequence).

  • Page 94: As Command

    Starts an energy detect scan. This command accepts an argument to specify the time in milliseconds to scan all channels. The device loops through all the available channels until the time elapses. It Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 95: Ea Command

    RF activity. When operating in Pin Sleep (SM = 1), D8 command must be set as a peripheral (D8=1) in order for the device to sleep. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 96: Sp Command

    The device only stays awake for ST time if RF or UART activity is detected upon wakeup or bit 8 of SO command is set to 1. Coordinator and End Device ST values must be equal. Parameter range 0x1 - 0x36EE80 (x 1 ms) Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 97: Dp (Disassociated Cyclic Sleep Period)

    SP operations Always wake A device configured for cyclic sleep will always remain awake for ST for ST time time before returning to sleep Set all other option bits to 0. Default Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 98: Fp (Force Poll)

    Interface data rate (b/s) BD parameter stored (HEX) 1200 (standard) 19,200 (standard) 115,200 (standard) E100 57,600 E139 1C200 115,200 1C273 Parameter range Standard baud rates: 0x0 - 0x0A Non-standard baud rates: 0x12C - 0x0EC400 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 99: Nb Command

    Parameter range 0 - 2 Parameter Description No parity Even parity Odd parity Default SB command Sets or displays the number of stop bits for UART communications. Parameter range 0 - 1 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 100: Ft Command

    When you enable API, you must format the serial data as API frames because Transparent operating mode is disabled. Parameter range 0 - 2 Parameter Description API disabled (operate in Transparent mode) Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 101: Ao Command

    Use this when debugging OTA firmware updates by enabling client-side messages to be sent out of the serial port. Parameter range 0 - 2 Parameter Description Suppress ZCL output Reserved Output supported ZCL packets Default Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 102: Command Mode Options

    Command mode. For more information, see Enter Command mode. Parameter range 0x2 - 0x6D3 (x 1 ms) Default 0x3E8 (one second) CN command Executable command. CN immediately exits Command mode and applies pending changes. Parameter range Default Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 103: Uart Pin Configuration Commands

    CTS flow control Digital input Digital output, low Digital output, high RS-485 enable, low Tx (0 V on transmit, high when idle) RS-485 enable, high Tx (high on transmit, 0 V when idle) Default Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 104: P3 Command

    The following commands affect the SPI serial interface on SMT and MMT variants. These commands are not applicable to the through-hole variant of the XBee3; see D1 through D4 and P2 for through- hole SPI support. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 105: P5 Command

    0, 1, 4, 5 Parameter Description Disabled SPI_MOSI Digital output, low Digital output, high Default P7 command Sets or displays the DIO17/SPI_SSEL configuration (Micro pin 14/SMT pin 15). This only applies to surface-mount and micro devices. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 106: P8 Command

    Digital output, low Digital output, high Default P9 command Sets or displays the DIO19/SPI_ATTN configuration (Micro pin 11/SMT pin 12). This only applies to surface-mount and micro devices. Parameter range 0, 1, 4, 5 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 107: I/O Settings Commands

    Digital output, low Digital output, high Default I/O settings commands The following commands configure the various I/O lines available on the XBee3 802.15.4 RF Module. D0 command Sets or displays the DIO0/ADC0/CB configuration (TH pin 20/SMT pin 33). Parameter range...

  • Page 108: D1 Command

    Sets or displays the DIO2/ADC2/TH_SPI_CLK configuration (Micro pin 29/SMT pin 31/TH pin 18). Parameter range SMT/MMT: 0, 2 - 5 TH: 0 - 5 Parameter Description Disabled SPI_CLK for through-hole devices N/A for surface-mount devices Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 109: D3 Command

    Sets or displays the DIO4/TH_SPI_MOSI configuration (Micro pin 23/SMT pin 24/TH pin 11). Parameter range SMT/MMT: 0, 3 - 5 TH: 0, 1, 3 - 5 Parameter Description Disabled SPI_MOSI for the through-hole device N/A for the surface-mount and micro device Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 110: D5 Command

    Sets or displays the DIO8/DTR/SLP_RQ configuration (Micro pin 9/SMT pin 10/TH pin 9). Parameter range 0, 1, 3 - 5 Parameter Description Disabled DTR/Sleep_Request (used with pin sleep and cyclic sleep with pin wake) Digital input Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 111: D9 Command

    When configured as PWM output (2): you can use M0 to explicitly control the PWM0 output. When used with Analog line passing, PWM0 corresponds with ADC0. Parameter range 0 - 5 Parameter Description Disabled RSSI PWM output Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 112: P1 Command

    Digital output, high Default P2 command Sets or displays the DIO12/TH_SPI_MISO configuration (Micro pin 5/SMT pin 5/TH pin 4). Parameter range SMT/MMT: 0, 3 - 5 TH: 0, 1, 3 - 5 Parameter Description Disabled Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 113: Pr Command

    By default, pull-up resistors are enabled on all disabled I/O lines. The following table defines the bit-field map for PR and PD commands. I/O line DIO4 DIO3 DIO2 DIO1 DIO0 DIO6/RTS DIO8/DTR/Sleep_Rq UART_DIN DIO5/Associate DIO9/Awake_SLEEP DIO12 DIO10/PWM-RSSI DIO11 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 114: Pd Command

    The PWM period is 64 µs and there are 0x03FF (1023 decimal) steps within this period. When M0 = 0 (0% PWM), 0x01FF (50% PWM), 0x03FF (100% PWM), and so forth. Parameter range 0 - 0x3FF Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 115: M1 Command

    If LT = 0, the device uses the default blink rate: 500 ms for a sleep coordinator, 250 ms for all other nodes. Parameter range 0, 0x14 - 0xFF (x 10 ms) Default Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 116: I/O Sampling Commands

    When operating in API mode (AP = 1), the command immediately returns an OK response. The data follows in the normal API format for DIO data. Extended I/O capability If A0 is set to 0 or 1, the XBee3 802.15.4 RF Module's IS I/O options are D0 command D9 command...

  • Page 117: Ir Command

    Micro pin 23/SMT pin 24/TH pin 11 DIO5 Micro pin 26/SMT pin 28/TH pin 15 DIO6 Micro pin 27/SMT pin 29/TH pin 16 DIO7 Micro pin 24/SMT pin 25/TH pin 12 DIO8 Micro pin 9/SMT pin 10/TH pin 9 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 118: Av (Analog Voltage Reference)

    IT after setting it reports the actual number of samples in a packet. Parameter range 0x1 - 0xFF Default IF command The number of sleep cycles that elapse between periodic I/O samples. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 119: Io Command

    IA is set to 0xFFFF. Note To enable API output, you must set AP command to an API mode (AP = 1 or 2). Parameter range 0 - 1 Parameter Description Disabled Enabled Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 120: T0 Command

    0, there is no timeout. Parameter range 0 - 0xFF Default T4 command Specifies how long pin D4 command holds a given value before it reverts to configured value. If set to 0, there is no timeout. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 121: T5 Command

    Default T8 command Specifies how long pin D8 command holds a given value before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0xFF Default Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 122: T9 Command

    Specifies how long both PWM outputs (P0, P1) output a given PWM signal before it reverts to the configured value (M0/M1). If set to 0, there is no timeout. This timeout only affects these pins when they are configured as PWM output. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 123: Diagnostic Commands - Firmware/Hardware Information

    Default VH command Reads the bootloader version of the device. Parameter range Default HV command Display the hardware version number of the device. Parameter range 0 - 0xFFFF [read-only] Default Set in firmware Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 124: C (Hardware/Software Compatibility)

    1 °C = 0x0001 and -1°C = 0xFFFF Parameter range 0 - 0xFFFF (Celsius) [read-only] Default DD command Stores the Digi device type identifier value. Use this value to differentiate between multiple types of devices. Parameter range 0 - 0xFFFFFFFF Default...

  • Page 125: Fr Command

    Immediately writes parameter values to non-volatile flash memory so they persist through a power cycle. Operating network parameters are persistent and do not require a WR command for the device to reattach to the network. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 126: Re Command

    Remote AT Command Request frame - 0x17. %F (Set Custom Default) When %F is received, the XBee3 802.15.4 RF Module takes the next command received and applies it to both the current configuration and the custom defaults, so that when defaults are restored with command the custom value is used.

  • Page 127: R1 (Restore Factory Defaults)

    AT commands Custom default commands R1 (Restore Factory Defaults) Restores factory defaults, ignoring any custom defaults set using %F (Set Custom Default). Parameter range Default Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 128 Operate in API mode API mode overview Use the AP command to set the operation mode API frame format Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 129: Operate In Api Mode

    Frame fields Byte Description Start delimiter 0x7E Length 2 - 3 Most Significant Byte, Least Significant Byte Frame data 4 - number (n) API-specific structure Checksum n + 1 1 byte Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 130: Api Operation With Escaped Characters (Ap Parameter = 2)

    2. Append it with the byte you want to escape, XORed with 0x20. In API mode with escaped characters, the length field does not include any escape characters in the frame and the firmware calculates the checksum with non-escaped data. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 131 1. Add all bytes of the packet, except the start delimiter 0x7E and the length (the second and third bytes). 2. Keep only the lowest 8 bits from the result. 3. Subtract this quantity from 0xFF. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 132 Subtract 0x47 from 0xFF and you get 0xB8 (0xFF - 0x47 = 0xB8). 0xB8 is the checksum for this data packet. If an API data packet is composed with an incorrect checksum, the XBee3 802.15.4 RF Module will consider the packet invalid and will ignore the data.
  • Page 133 Modem Status frame - 0x8A Transmit Status frame - 0x8B Receive Packet frame - 0x90 Explicit Rx Indicator frame - 0x91 I/O Data Sample Rx Indicator frame - 0x92 Remote Command Response frame - 0x97 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 134: Tx Request: 64-Bit Address Frame - 0X00

    0x04 = Send packet with Broadcast PAN ID. Set all other bits to 0. The RF data length can be up to 110 bytes, but may be less depending on RF data 14-n other factors discussed in Maximum payload. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 135: Tx Request: 16-Bit Address - 0X01

    0x04 = Send packet with Broadcast PAN ID. Set all other bits to 0. RF data The RF data length can be up to 116 bytes, but may be less depending on other factors discussed in Maximum payload. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 136: At Command Frame - 0X08

    The following example illustrates an AT Command frame where the device's SL parameter value is queried. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x04 Frame type 0x08 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 137 Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x08 Frame type 0x08 Frame ID 0x4D AT command 0x44 (D) 0x4C (L) Parameter value 7-10 0xFF 0xFF Checksum 0x1C Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 138: At Command - Queue Parameter Value Frame - 0X09

    You can set the broadcast radius from 0 up to NH. If set to 0, the value of NH specifies the broadcast radius (recommended). This parameter is only used for broadcast transmissions. You can read the maximum number of payload bytes with the NP command. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 139 The example shows how to send a transmission to a device if you disable escaping (AP = 1), with destination address 0x0013A200 400A0127, and payload “TxData0A”. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x16 Frame type 0x10 Frame ID 0x01 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 140: Explicit Addressing Command Frame - 0X11

    ID, and profile ID. This frame causes the device to send payload data as an RF packet to a specific destination, using specific source and destination endpoints, cluster ID, and profile ID. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 141 21-22 Data 23-n Data that is sent to the destination device. Payload Transmit Options bit field Transmit Request frame - 0x10. Example The following example sends a data transmission to a device with: Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 142 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x01 0x23 0x84 LSB12 0x00 Reserved 0xFF 0xFE Source endpoint 0xE8 Destination endpoint 0xE8 Cluster ID 0x00 0x11 Profile ID 0xC1 0x05 Reserved 21-22 0x00 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 143 Frame descriptions Explicit Addressing Command frame - 0x11 Frame data fields Offset Example Data payload 0x54 0x78 0x44 0x61 0x74 0x61 Checksum 0xA6 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 144: Remote At Command Request Frame - 0X17

    Command name: two ASCII characters that identify the command. 16-17 Command 18-n If present, indicates the parameter value you request for a given register. parameter If no characters are present, it queries the register. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 145: Rx Packet: 64-Bit Address Frame - 0X80

    Bit field: 0 = [reserved]. 1 = Packet was a broadcast packet. 2 = Packet was broadcast across all PANs. 3-7 = [reserved]. The RF data that the device receives. Received 14-n data Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 146: Receive Packet: 16-Bit Address Frame - 0X81

    Options Bit 1 = Packet was a broadcast packet. Bit 2 = Packet was broadcast across all PANs. Bits 3 - 7 = [reserved]. RF data The RF data that the device receives. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 147: Rx (Receive) Packet: 64-Bit Address Io Frame - 0X82

    DIO lines. DIO lines that do not have sampling enabled return 0. If no DIO line is enabled, no bytes are included in the frame. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 148 AD0 to AD5. The following table shows the Channel Indicator and Digital Samples bit fields. Bit field Description Reserved 3 bits A3 - A0 4 analog bits D8 - D0 9 digital bits Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 149: Rx Packet: 16-Bit Address I/O Frame - 0X83

    DIO lines. DIO lines that enabled) do not have sampling enabled return 0. If no DIO line is enabled, no (see bit field bytes are included in the frame. table below) Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 150 AD0 to AD5. n - 1 ADCn ADCn The following table shows the Channel Indicator bit field. Bit field Description Reserved 3 bits A3 - A0 4 analog bits D8 - D0 9 digital bits Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 151: At Command Response Frame - 0X88

    If you change the BD parameter on a local device with a frame ID of 0x01, and the parameter is valid, the user receives the following response. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x05 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 152 Offset Example Frame type 0x88 Frame ID 0x01 AT command 0x42 (B) 0x44 (D) Command status 0x00 Command data (No command data implies the parameter was set rather than queried) Checksum 0xF0 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 153: Tx Status Frame - 0X89

    0x000000000000FFFF), status 0x01 and 0x21 will never be returned because broadcasts are sent unacknowledged. Example The following example shows a successful status received. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x03 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 154 Frame descriptions TX Status frame - 0x89 Frame data fields Offset Example Frame type 0x89 Frame ID 0x01 Status 0x00 Checksum 0x75 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 155: Modem Status Frame - 0X8A

    When a device powers up, it returns the following API frame. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 LSB 2 0x02 Frame type 0x8A Status 0x00 Checksum 0x75 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 156: Transmit Status Frame - 0X8B

    In the following example, the destination device reports a successful unicast data transmission. The outgoing Transmit Request that this response frame came from uses Frame ID of 0x47. Frame Fields Offset Example Start delimiter 0x7E Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 157 Transmit Status frame - 0x8B Frame Fields Offset Example Length MSB 1 0x00 LSB 2 0x07 Frame type 0x8B Frame ID 0x47 Reserved 0xFF 0xFE Transmit retry count 0x00 Delivery status 0x00 Reserved 0x02 Checksum 0x2E Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 158: Receive Packet Frame - 0X90

    RxData. If AO = 0 on the receiving device, it sends the following frame out its serial interface. Frame data fields Offset Example Start delimiter 0x7E Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 159 Frame type MSB 4 0x00 64-bit source address 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Receive options 0x01 Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x11 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 160: Explicit Rx Indicator Frame - 0X91

    If a device sends the transmission: With source and destination endpoints of 0xE0 Cluster ID = 0x2211 Profile ID = 0xC105 If AO = 1 on the receiving device, it sends the following frame out its serial interface. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 161 LSB 11 0xAA Reserved 0xFF 0xFE Source endpoint 0xE0 Destination endpoint 0xE0 Cluster ID 0x22 0x11 Profile ID 0xC1 0x05 Receive options 0x02 Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x68 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 162: I/O Data Sample Rx Indicator Frame - 0X92

    AD1. It reads the digital lines to be 0x0014 and the analog sample value is 0x0225. The complete example frame is: 7E00 1492 0013 A200 4052 2BAA FFFE 0101 001C 0200 1402 25F9 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 163 MSB 12 0xFF LSB 13 0xFE Receive options 0x01 Number of samples 0x01 Digital channel mask 0x00 0x1C Analog channel mask 0x02 Digital samples (if included) 0x00 0x14 Analog sample 0x02 0x25 Checksum 0xF5 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 164: Remote Command Response Frame - 0X97

    0 = OK 1 = ERROR 2 = Invalid Command 3 = Invalid Parameter 4 = Remote Command Transmission Failed Command data 18-n The value of the requested register in hexadecimal notation (non-ASCII). Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 165: Ota Firmware Upgrade Process For 802.15.4

    ZCL message output Image Notify Create the Image Notify request Query Next Image request Query Next Image response Image Block request Image Block response Upgrade End request Upgrade End response OTA error handling Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 166: Ota/Otb File

    The file version field contains additional hardware/software compatibility information. We recommend that if you intend to perform an OTA update, you use the OTA header extracted from the file so that you can avoid undesired behavior. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 167: Hardware/Software Compatibility

    Storage Hardware/software compatibility The Hardware Software Compatibility number ensures that an incompatible firmware is not flashed on to the XBee3 802.15.4 RF Module. To obtain this value, query %C (Hardware/Software Compatibility) on the target device. You can successfully update the device to a firmware if, and only if, the value of %C of the image is greater than or equal to the value returned by the device when you query %C.

  • Page 168: Zcl Message Output

    The server sends the Image Notify message to the client informing the device of the presence of an update image. The Image Notify message is sent when the upgrade process is initiated from the server. Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 169: Create The Image Notify Request

    MSB 5 0x00 0x13 0xA2 0xFE 0x00 0x00 0x00 0x03 16-bit destination address 0x28 0x2F Source Endpoint 0xE8 Destination Endpoint 0xE8 Cluster ID 0x00 0x19 Profile ID 0xC1 0x05 Broadcast radius 0x00 Transmit options 0x00 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 170: Query Next Image Request

    The server emits the following frame after receiving the request from the client: Frame data fields Offset Example Comments Start delimiter 0x7E Length MSB 1 0x00 LSB   2 0x1E Frame Type 0x91 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 171 16-bit source address 0x28 LSB  0x2F Source Endpoint 0xE8 Destination Endpoint 0xE8 Cluster ID 0x00 0x19 Profile ID 0xC1 0x05 Receive options 0x01 Data ZCL frame Frame control 0x01 payload header Transaction sequence 0x00 number Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 172: Query Next Image Response

    0x7E - NOT_AUTHORIZED: The server is not authorized to update the client. Frame data fields Offset Example Comments Start delimiter 0x7E Length MSB 1 0x00 LSB   2 0x24 Frame Type 0x11 Frame ID 0x01 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 173 0xA2 0xFE 0x00 0x00 0x00 LSB  0x03 16-bit destination address 0x28 LSB  0x2F Source Endpoint 0xE8 Destination Endpoint 0xE8 Cluster ID 0x00 0x19 Profile ID 0xC1 0x05 Broadcast radius 0x00 Transmit options 0x00 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 174: Image Block Request

    The size of the OTA upgrade image is usually obtained by the client in the Query Next Image response message and hence it knows the exact number of Image Block requests it needs to send. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 175 MSB 4 0x00 0x13 0xA2 0xFE 0x00 0x00 0x00 LSB  0x03 16-bit source address 0x28 LSB  0x2F Source Endpoint 0xE8 Destination Endpoint 0xE8 Cluster ID 0x00 0x19 Profile ID 0xC1 0x05 Receive options 0x01 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 176: Image Block Response

    SUCCESS status on being able to retrieve the data for the client. The server uses the file offset sent by the client to determine the location of the requested data within the OTA upgrade image. If you wish to cancel the update process, send an ABORT (0x95) status. Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 177 0xA2 0xFE 0x00 0x00 0x00 LSB  0x03 16-bit destination address 0x28 LSB  0x2F Source Endpoint 0xE8 Destination Endpoint 0xE8 Cluster ID 0x00 0x19 Profile ID 0xC1 0x05 Broadcast radius 0x00 Transmit options 0x00 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 178 0x40 64 byte blocks Data Image Block Size payload payload 0xEB- Data Image Block Data An image block of the size 0x00 payload payload mentioned in Image Block Size 0x4E Checksum Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 179: Upgrade End Request

    MSB 4 0x00 0x13 0xA2 0xFE 0x00 0x00 0x00 LSB  0x03 16-bit source address 0x28 LSB  0x2F Source Endpoint 0xE8 Destination Endpoint 0xE8 Cluster ID 0x00 0x19 Profile ID 0xC1 0x05 Receive options 0x01 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 180: Upgrade End Response

    Frame data fields Offset Example Comments Start delimiter 0x7E Length MSB 1 0x00 LSB   2 0x24 Frame Type 0x11 Frame ID 0x01 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 181 0xA2 0xFE 0x00 0x00 0x00 LSB  0x03 16-bit destination address 0x28 LSB  0x2F Source Endpoint 0xE8 Destination Endpoint 0xE8 Cluster ID 0x00 0x19 Profile ID 0xC1 0x05 Broadcast radius 0x00 Transmit options 0x00 Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 182 0x10 Image type 0x00 0x00 Firmware version 0x01 0x10 0x00 0x00 Current Time 0xF0  32 bit unsigned integer Seconds since Epoch 0x1A 0x53 0x21 Upgrade Time LSB38 0x00 0x1B 0x53 0x21 Checksum 0xE5 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 183: Ota Error Handling

    Start Delimiter Length 00 17 Frame Type Source Address FF FF FF FF FF FF FF FF Source Address FF FF Source Endpoint Destination Endpoint Cluster ID 00 19 Profile ID C1 05 Digi XBee3® 802.15.4 RF Module User Guide...

  • Page 184: Upgrade End Request Error Statuses

    The status field in the Upgrade End request informs the server of any errors during the download or verification of the OTA firmware update image on the client. The error codes that could be reported Digi XBee3® 802.15.4 RF Module User Guide...
  • Page 185 ZCL OTA Command Status Error Message 0x06 0x94 Client Timed Out Upgrade End Request 0x96 Invalid OTA Image 0x95 Client Aborted Upgrade 0x05 Storage Erase Failed 0x87 Contact Tech Support (Highly unlikely to occur) Digi XBee3® 802.15.4 RF Module User Guide...

Table of Contents