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
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 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: Table Of Contents

    Change the firmware protocol Getting started Verify kit contents Assemble the hardware Plug in the XBee3 802.15.4 RF Module How to unplug an XBee module Configure the device using XCTU Configure remote devices Configure the devices for a range test...
  • Page 4 Peer-to-peer networks Clear Channel Assessment (CCA) CCA operations Serial interface Serial receive buffer Serial transmit buffer UART data flow Flow control Sleep support Sleep modes Sleep parameters Sleep current Sleep pins Node discovery Remote configuration commands Send a remote command Apply changes on remote devices Remote command responses AT commands...
  • Page 5 Command mode options CN (Exit Command mode) CT (Command Mode Timeout) GT (Guard Times) CC (Command Character) Sleep settings SM (Sleep Mode) D8 (DIO8/DTR/SLP_RQ) D9 (DIO9/ON_SLEEP) I/O settings commands D0 (DIO0 Configuration) D1 (DIO1 Configuration) D2 (DIO2 Configuration) D3 (DIO3 Configuration) D4 (DIO4 Configuration) D5 (DIO5/Associate Configuration) P0 (DIO10/PWM0 Configuration...
  • Page 6 Receive Packet: 16-bit address frame - 0x81 AT Command Response frame - 0x88 TX Status frame - 0x89 Modem Status frame - 0x8A Remote Command Response frame - 0x97 XBee3® 802.15.4 RF Module User Guide...

  • Page 7: 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 8: Applicable Firmware And Hardware

    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 either of the following protocols: Zigbee 802.15.4 To change protocols, use the Update firmware feature in XCTU and select the firmware.
  • Page 9 Getting started 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 XBee3® 802.15.4 RF Module User Guide...

  • Page 10: Getting Started

    Getting 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 11: 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 module into the XBee Grove Development Board. Make sure the board is NOT powered (either by the micro USB or a battery) when you plug in the XBee module.

  • Page 12: How To Unplug An Xbee Module

    XBee Configuration and Test Utility (XCTU) is a multi-platform program that enables users to interact with Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices.

  • Page 13: Configure The Devices For A Range Test

    Getting started Configure the devices for a range test 7. Click Add selected devices in the Discovering remote devices dialog. The discovered remote device appears below XBEE_A. 8. Select the remote device XBEE_B, and configure the following parameter: LT: FF (hexadecimal representation for 2550 ms) 9.

  • Page 14: Perform A Range Test

    Getting started Perform a range test 7. Click the Write radio settings button. After you write the radio settings for each device, their names appear in the Radio Modules area. The Port indicates that the LOCAL_DEVICE is in API mode. 8.
  • Page 15 Getting started Perform a range test 4. Click and select Range test. The Radio Range Test dialog appears. 5. 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. XBee3®...
  • Page 16 Getting started Perform a range test 6. Click to begin the range test. If the test is running properly, the packets sent should match the packets received. You will also see the received signal strength indicator (RSSI) update for each radio after each reception.

  • Page 17: Modes

    Modes Serial modes Command mode XBee3® 802.15.4 RF Module User Guide...

  • Page 18: Serial Modes

    The firmware operates in several different modes. Two top-level modes establish how the device communicates with other devices through its serial interface: Transparent operating mode and API operating mode. Use the AP command to choose Serial mode. XBee3 802.15.4 RF Modules use Transparent operation as the default serial mode.

  • Page 19: Enter Command Mode

    Modes Command mode you want to read or set any parameter of the device when operating in Transparent 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 the device issues and then by some optional configuration values. Command mode is available on the UART interface in both Transparent and API modes.

  • Page 20: Apply Command Changes

    Modes Command mode Multiple AT commands You can send multiple AT commands at a time when they are separated by a comma in Command mode; for example, ATSH,SL. Parameter format Refer to the list of AT commands for the format of individual AT command parameters. Numeric parameters will always be represented in hexadecimal format.

  • Page 21: Operation

    Operation Software libraries Addressing Maximum payload Networking Clear Channel Assessment (CCA) Serial interface Sleep support Node discovery Remote configuration commands XBee3® 802.15.4 RF Module User Guide...

  • Page 22: Software Libraries

    Operation 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. The package includes the XBee library, its source code and a collection of samples that help you develop Java applications to communicate with your XBee devices.

  • Page 23: Maximum Payload

    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 24: Networking

    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 25: Xbee Retries Configuration

    802.15.4 MAC-Layer retries. 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 (XBee Retries) command.

  • Page 26: Peer-To-Peer Networks

    Failure) 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. This means that devices remain synchronized without the use of master/server configurations and each device in the network shares both roles of master and slave.

  • Page 27: Cca Operations

    0xFFFF. To get new statistics, you can set EC back to Serial interface The XBee3 802.15.4 RF Module interfaces to a host device through a serial port. The device can communicate through its serial port with: Through logic and voltage compatible universal asynchronous receiver/transmitter (UART).

  • Page 28: Uart Data Flow

    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. Low-asserted signals have a horizontal line over the signal name.
  • Page 29 Operation Serial interface CTS flow control If you enable CTS flow control (D7 command), when the serial receive buffer is 17 bytes away from being full, the device de-asserts CTS (sets it high) to signal to the host device to stop sending serial data.

  • Page 30: Sleep Support

    Sleep parameters See the SM (Sleep Mode) for the parameter's description, range and default values. 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 <2 µA @ 25ºC...

  • Page 31: Sleep Pins

    Operation Node discovery Sleep pins The following table describes the three external device pins associated with sleep. Pin name Description DTR/SLEEP_ For SM = 1, high puts the device to sleep and low wakes it up. If D7 = 1, high indicates that the device is asleep and low indicates that it is awake and ready to receive serial data.

  • Page 32: Apply Changes On Remote Devices

    Operation Remote configuration commands 3. The command and parameter data (optional). If (and only if) all nodes in the PAN have unique short addresses, then remote configuration commands can be sent to 16-bit short addresses by setting the short address in the API frame for Remote AT commands. In that case, the 64-bit address is unused and does not matter.

  • Page 33: At Commands

    AT commands Network commands Addressing commands RF interfacing commands UART serial interfacing Command mode options Sleep settings I/O settings commands Diagnostic commands Memory access commands XBee3® 802.15.4 RF Module User Guide...

  • Page 34: Network Commands

    AT commands Network commands Network commands This section lists the AT commands that are used during a form and join attempt. ID (Extended PAN ID) Set or read the user network identifier. Devices must have the same network identifier to communicate with each other. Devices can only communicate with other devices that have the same network identifier and channel configured.
  • Page 35 NT timeout. 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 36: Ni (Node Identifier)

    AT commands Network commands Default NI (Node Identifier) Stores the node identifier string for a device, which is a user-defined name or description of the device. This can be up to 20 ASCII characters. Parameter range A string of case-sensitive ASCII printable characters from 0 to 20 bytes in length. A carriage return or a comma automatically ends the command.

  • Page 37: No (Node Discovery Options)

    AT commands Network commands Each device that responds to the request will generate a separate AT Command Response frame - 0x88. Broadcast an ND command to the network. If the command includes an optional node identifier string parameter, only those devices with a matching NI string respond without a random offset delay. If the command does not include a node identifier string parameter, all devices respond with a random offset delay.

  • Page 38: Addressing Commands

    AT commands Addressing commands Addressing commands SH (Serial Number High) Displays the upper 32 bits of the unique IEEE 64-bit extended address assigned to the XBee in the factory. The 64-bit source address is always enabled. This value is read-only and it never changes. Parameter range 0x0013A200 - 0x0013A2FF [read-only] Default...

  • Page 39: Dl (Destination Address Low)

    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 40: Mm (Mac Mode)

    Digi mode No ACKs Default DD (Device Type Identifier) Stores the Digi device type identifier value. Use this value to differentiate between multiple types of devices. If you change DD, RE (Restore Defaults) will not restore defaults. The only way to get DD back to default values is to explicitly set it to defaults.

  • Page 41: Rf Interfacing Commands

    AT commands RF interfacing commands RF interfacing commands The following AT commands affect the RF interface of the device. PL (TX Power Level) Sets or displays the power level at which the device transmits conducted power. Note If operating on channel 26 (CH = 0x1A), output power will be capped and cannot exceed 8 dBm regardless of the PL setting.

  • Page 42: Ca (Cca Threshold)

    AT commands RF interfacing commands Default 0xC (IEEE 802.15.4 channel 12) CA (CCA Threshold) Defines the Clear Channel Assessment (CCA) threshold. Prior to transmitting a packet, the device performs a CCA to detect energy on the channel. If the device detects energy above the CCA threshold, it will not transmit the packet.

  • Page 43: Uart Serial Interfacing

    AT commands UART serial interfacing 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 44: Nb (Parity)

    AT commands UART serial interfacing Parameter Description 4800 b/s 9600 b/s 19200 b/s 38400 b/s 57600 b/s 115200 b/s 230400 b/s Default 3 (9600 baud) NB (Parity) Set or read the serial parity settings for UART communications. The device does not actually calculate and check the parity. It only interfaces with devices at the configured parity and stop bit settings for serial error detection.

  • Page 45: Ap (Api Enable)

    AT commands UART serial interfacing Default AP (API Enable) Set or read the API mode setting. The device can format the RF packets it receives into API frames and sends them out the serial port. When you enable API, you must format the serial data as API frames because Transparent operating mode is disabled.

  • Page 46: D6 (Dio6/Rts)

    AT commands Command mode options D6 (DIO6/RTS) Sets or displays the DIO6/RTS configuration (Micro pin 27/SMT pin 29). Parameter range 0, 1, 4 - 5 Parameter Description Disabled RTS flow control Digital output, low Digital output, high Default D7 (DIO7/CTS) Sets or displays the DIO7/CTS configuration (Micro pin 24/SMT pin 25).

  • Page 47: Cn (Exit Command Mode)

    AT commands Sleep settings CN (Exit Command mode) Executable command. This command immediately exits Command mode and applies pending changes. Parameter range Default CT (Command Mode Timeout) Sets or displays the Command mode timeout parameter. If a device does not receive any valid commands within this time period, it returns to Idle mode from Command mode.

  • Page 48: Sm (Sleep Mode)

    AT commands Sleep settings SM (Sleep Mode) Sets or displays the sleep mode of the device. By default, Sleep Modes are disabled (SM = 0) and the device remains in Idle/Receive mode. When in this state, the device is constantly ready to respond to either serial or RF activity. When operating in Pin Sleep (SM = 1), D8 must be set as a peripheral (D8=1) in order for the device to sleep.

  • Page 49: I/O Settings Commands

    AT commands I/O settings commands Parameter Description Disabled ON/SLEEP output Digital output, low Digital output, high Default I/O settings commands The following AT commands are I/O settings commands. D0 (DIO0 Configuration) Sets or displays the DIO0 (Micro pin 31/SMT pin 33). Parameter range 0, 4, 5 Parameter...

  • Page 50: D2 (Dio2 Configuration)

    AT commands I/O settings commands Parameter Description Disabled Digital output, low Digital output, high Default D2 (DIO2 Configuration) Sets or displays the DIO2 configuration (Micro pin 29/SMT pin 31). Parameter range 0, 4, 5 Parameter Description Disabled Digital output, low Digital output, high Default D3 (DIO3 Configuration)

  • Page 51: D4 (Dio4 Configuration)

    AT commands I/O settings commands Parameter Description Digital output, low Digital output, high Default D4 (DIO4 Configuration) Sets or displays the DIO4 configuration (Micro pin 23/SMT pin 24). Parameter range 0, 4, 5 Parameter Description Disabled Digital output, low Digital output, high Default D5 (DIO5/Associate Configuration) Sets or displays the DIO5 configuration (Micro pin 26/SMT pin 28).

  • Page 52: P1 (Dio11 Configuration)

    AT commands I/O settings commands Parameter Description Digital output, default low Digital output, default high Default P0 (DIO10/PWM0 Configuration Sets or displays the DIO10/RSSI configuration (Micro pin 7/SMT pin 7). Parameter range 0, 1, 4, 5 Parameter Description Disabled RSSI PWM output Digital output, low Digital output, high Default...

  • Page 53: P5 (Dio15 Configuration)

    AT commands I/O settings commands Default P5 (DIO15 Configuration) Sets or displays the DIO15 configuration (Micro pin 16/SMT pin 17). Parameter range 0, 4, 5 Parameter Description Disabled Digital output, low Digital output, high Default PR (Pull-up/Down Resistor Enable) The bit field that configures the internal pull-up/down resistor status for the I/O lines. If you set a PR bit to 1, it enables the pull-up/down resistor If you set a PR bit to 0, it specifies no internal pull-up/down resistor.

  • Page 54: Pd (Pull Up/Down Direction)

    AT commands I/O settings commands I/O line UART_DIN DIO5/Associate DIO9/Awake_nSleep DIO12 DIO10/PWM-RSSI DIO11 DIO7/ CTS UART_DOUT DIO15 Parameter range 0 - 0xFFFFF (bit field) Default 0xFFFF Example Sending the command ATPR 6F turn bits 0, 1, 2, 3, 5 and 6 ON, and bits 4 and 7 OFF. The binary equivalent of 0x6F is 01101111.

  • Page 55: Diagnostic Commands

    AT commands Diagnostic commands If LT = 0, the device uses the default blink rate of 250 ms. Parameter range 0xA - 0xFF Default Diagnostic commands The following AT commands are diagnostic commands. AI (Association Indication) Reads the Association status code to monitor association progress. The following table provides the status codes and their meanings.

  • Page 56: Vr (Firmware Version)

    AT commands Diagnostic commands Default VR (Firmware Version) Reads the firmware version on a device. Parameter range 0x2000 - 0x2FFF Default Set in the firmware VL (Version Long) Shows detailed version information including the application build date and time. Parameter range Default VH command Reads the bootloader version of the device.

  • Page 57: Tp Command

    AT commands Memory access commands Default TP command The current module temperature in degrees Celsius. The temperature is represented in two’s complement, as shown in the following example:  1 °C = 0x0001 and -1°C = 0xFFFF Parameter range 0 - 0xFFFF (Celsius) Default CK (Configuration CRC) Reads the cyclic redundancy check (CRC) of the current AT command configuration settings to...

  • Page 58: Wr (Write)

    AT commands Memory access commands Issuing a 0x08 Local AT Command API frame. Issuing a remote 0x17 AT Command API frame with option bit 1 set. Example: Altering the UART baud rate with the BD command does not change the operating baud rate until after an AC command is received;...

  • Page 59: Operate In Api Mode

    Operate in API mode API mode overview API frame specifications Frame descriptions XBee3® 802.15.4 RF Module User Guide...

  • Page 60: Api Mode Overview

    API operation with escaped characters (only possible on UART). Software flow control (XON and XOFF) uses API mode 2. The XBee3 802.15.4 RF Module does not support software flow control and only supports API mode 2 for compatibility with other XBee devices.

  • Page 61: Api Frame Format

    For more information on using this API mode, refer to the following knowledge base article: http://knowledge.digi.com/articles/Knowledge_Base_Article/Escaped-Characters-and-API-Mode-2 The following table shows the structure of an API frame with escaped characters:...

  • Page 62: Calculate And Verify Checksums

    Operate in API mode API frame specifications Length The length field specifies the total number of bytes included in the frame's data field. Its two-byte value excludes the start delimiter, the length, and the checksum. Frame data This field contains the information that a device receives or will transmit. The structure of frame data depends on the purpose of the API frame: Frame data Start...
  • Page 63 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 64: Frame Descriptions

    Operate in API mode Frame descriptions Frame descriptions The following sections describe the API frames. API frames The device sends multi-byte values in big-endian format. The XBee 802.15.4 RF Module supports API frames in the following table. Request frames are less than 0x80 and responses are always 0x80 or higher.
  • Page 65 Operate in API mode Frame descriptions Frame data fields Offset Description Identifies the data frame for the host to correlate with a subsequent ACK, Frame ID which is a 0x89 (Tx status) frame that indicates the packet was transmitted successfully. If set to 0, the device does not send a response. 64-bit Set to the 64-bit address of the destination device.

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

    Operate in API mode Frame descriptions TX Request: 16-bit address - 0x01 Description A TX Request message causes the device to transmit data as an RF Packet. Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications.

  • Page 67: At Command Frame - 0X08

    Operate in API mode Frame descriptions AT Command Frame - 0x08 Description Use this frame to query or set command parameters on the local device. This API command applies changes after running the command. You can query parameter values by sending the 0x08 AT Command frame with no parameter value field (the two-byte AT command is immediately followed by the frame checksum).
  • Page 68 Operate in API mode Frame descriptions Frame data fields Offset Example AT command 0x53 (S) 0x4C (L) Parameter value (optional) Checksum 0x45 The following example illustrates an AT Command frame when you modify the device's DL parameter value to a broadcast address of 0xFFFF. A non-zero Frame ID can be used to correlate the AT command request with the corresponding response frame.

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

    Operate in API mode Frame descriptions AT Command - Queue Parameter Value frame - 0x09 Description This frame allows you to query or set device parameters. In contrast to the AT Command (0x08) frame, this frame queues new parameter values and does not apply them until you issue either: The AT Command (0x08) frame (for API type) The AC command When querying parameter values, the 0x09 frame behaves identically to the 0x08 frame;...

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

    Operate in API mode Frame descriptions Remote AT Command Request frame - 0x17 Description Used to query or set device parameters on a remote device. For parameter changes on the remote device to take effect, you must apply changes, either by setting the Apply Changes options bit, or by sending an AC command to the remote.

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

    Operate in API mode Frame descriptions RX Packet: 64-bit Address frame - 0x80 Description When a device receives an RF data packet from a device configured to use 64-bit addressing (MY = FFFF), it sends this frame out the serial interface. Format The following table provides the contents of the frame.

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

    Operate in API mode Frame descriptions Receive Packet: 16-bit address frame - 0x81 Description When the device receives an RF packet from a device configured to use 16 bit addressing (MY < FFFE), it sends this frame out the serial interface. Format The following table provides the contents of the frame.

  • Page 73: At Command Response Frame - 0X88

    Operate in API mode Frame descriptions AT Command Response frame - 0x88 Description A device sends this frame in response to an AT Command (0x08) frame and a queued AT command (0x09). Some commands send back multiple frames; for example, the ND command. This command ends by sending a frame with a status of 0 (OK) and no value.
  • Page 74 Operate in API mode Frame descriptions Frame data fields Offset Example AT command 0x42 (B) 0x44 (D) Command status 0x00 Command data (No command data implies the parameter was set rather than queried) Checksum 0xF0 XBee3® 802.15.4 RF Module User Guide...

  • Page 75: Tx Status Frame - 0X89

    Operate in API mode Frame descriptions TX Status frame - 0x89 Description When a TX request: 64-bit address (0x00) or 16-bit address (0x01) is complete, the device sends a TX Status frame. This message indicates if the packet transmitted successfully or if there was a failure. Format The following table provides the contents of the frame.
  • Page 76 Operate in API mode Frame descriptions Frame data fields Offset Example Frame ID 0x01 Status 0x00 Checksum 0x75 XBee3® 802.15.4 RF Module User Guide...

  • Page 77: Modem Status Frame - 0X8A

    Operate in API mode Frame descriptions Modem Status frame - 0x8A Description Devices send the status messages in this frame in response to specific conditions. Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications.

  • Page 78: Remote Command Response Frame - 0X97

    Operate in API mode Frame descriptions Remote Command Response frame - 0x97 Description If a device receives this frame in response to a Remote Command Request (0x17) frame, the device sends an AT Command Response (0x97) frame out the serial interface. Some commands, such as the ND command, may send back multiple frames.

Table of Contents