EasyManua.ls Logo

Digi XBee User Manual

Digi XBee
307 pages
To Next Page IconTo Next Page
To Next Page IconTo Next Page
To Previous Page IconTo Previous Page
To Previous Page IconTo Previous Page
Page #152 background imageLoading...
Page #152 background image
API Operation Data bytes that need to be escaped:
XBee/XBee-PR S2C ZigBe RF Module
152
Data bytes that need to be escaped:
Byte Description
0x7E Frame Delimiter
0x7D Escape
0x11 XON
0x13 XOFF
Example: Raw serial data before escaping interfering bytes:
0x7E 0x00 0x02 0x23 0x11 0xCB
0x11 needs to be escaped which results in the following frame:
0x7E 0x00 0x02 0x23 0x7D 0x31 0xCB
Note In the previous example, the length of the raw data (excluding the checksum) is 0x0002 and the
checksum of the non-escaped data (excluding frame delimiter and length) is calculated as:
0xFF - (0x23 + 0x11) = (0xFF - 0x34) = 0xCB.
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 transmits. The structure of frame data
depends on the purpose of the API frame:
Start
delimiter Length
Frame data
ChecksumAPI identifier
Identifier-specific Data
1 2 3 4 5 6 7 8 9 ... n n+1
0x7E MSB LSB
cmdID
cmdData
Single
byte
The cmdID frame (API-identifier) indicates which API messages contains the cmdData frame
(Identifier-specific data). The device sends multi-byte values big endian format.
The XBee/XBee-PRO ZigBee RF Module supports the following API frames:
API frame names API ID
AT Command 0x08
AT Command - Queue Parameter Value 0x09

Table of Contents

Other manuals for Digi XBee

Question and Answer IconNeed help?

Do you have a question about the Digi XBee and is the answer not in the manual?

Digi XBee Specifications

General IconGeneral
Operating Frequency2.4 GHz
RF Data Rate250 kbps
ModelXBee S2C
CategoryControl Unit
Operating Voltage2.1 to 3.6V DC
Operating Temperature-40 to +85 °C
InterfaceUART
Dimensions24.38 x 27.61 x 9.14 mm

Summary

Technical Specifications

Performance Specifications

Details the performance metrics like range, transmit power, and receiver sensitivity for different XBee models.

Power Requirements

Outlines the supply voltage and operating/sleep current specifications for the XBee modules.

General Specifications

Provides general information on operating frequency band and form factor for XBee devices.

Networking and Security Specifications

Describes supported network topologies, channels, and addressing options for ZigBee devices.

Communication Interface Specifications

Details the specifications for UART and SPI communication interfaces on XBee modules.

Regulatory Conformity Summary

Summarizes agency approvals and compliance information for XBee devices across different regions.

Serial Communication Specifications

Details UART and SPI pin assignments and GPIO specifications for XBee modules.

Hardware Specifications for the Programmable Variant

Provides electrical specifications for GPIO pins and secondary processor current consumption.

Hardware

Mechanical Drawings

Illustrates the physical dimensions and layout for XBee surface-mount and through-hole modules.

Pin Signals for the Surface-Mount Module

Details the pin locations and descriptions for the XBee surface-mount device's SMT pads.

Pin Signals for the Through-Hole Module

Details the pin assignments and descriptions for the XBee through-hole module.

EM357 Pin Mappings

Shows the mapping of EM357 pins to XBee pads/pins and other usage for programmable modules.

Design Notes

Provides guidelines for power supply design, board layout, and antenna performance for robust designs.

Operation

Serial Interface

Explains how the XBee module interfaces with host devices via serial ports (UART/SPI).

SPI Communications

Details the SPI communication protocol, signals, and operation modes (slave mode).

Serial Buffers

Describes internal buffers for serial and RF data collection and processing.

UART Flow Control

Explains RTS/CTS flow control for managing serial data flow between host and XBee.

Serial Interface Protocols

Compares Transparent and API operating modes for serial data communication.

Modes of Operation

Describes the different operational modes: Idle, Transmit, Receive, Command, and Sleep.

ZigBee Networks

About the ZigBee Specification

Provides an overview of the ZigBee standard, its layers, and the ZigBee Alliance.

ZigBee Networking Concepts

Explains ZigBee device types (Coordinator, Router, End Device) and networking concepts.

PAN ID

Details the 16-bit and 64-bit PAN ID requirements for ZigBee network identification.

ZigBee Application Layers: In Depth

Provides a detailed look at ZigBee application layers (APS, ZDO), clusters, and profiles.

ZigBee Coordinator Operation

Form a Network

Describes the coordinator's role in network formation, including channel and PAN ID selection.

Security Policy

Explains how the security policy determines device joining and authentication.

Channel Selection

Details the process of selecting an optimal operating channel via energy scans.

PAN ID Selection

Describes the process of selecting a PAN ID by scanning for beacons and resolving conflicts.

Coordinator Startup

Lists network formation commands and behaviors when a coordinator starts a network.

Permit Joining

Explains how to configure the coordinator to allow or deny devices joining the network.

Reset the Coordinator

Describes how coordinator settings are retained through power cycles and resets.

ZigBee Router Operation

Discover ZigBee Networks

Explains how routers scan for and discover available ZigBee networks.

Join a Network

Details the process for a router to send an association request and join a network.

Authentication

Describes the authentication process required for routers joining secure networks.

Persistent Data

Explains what network information routers retain through power cycles and resets.

Router Network Connectivity

Covers how routers maintain network connectivity and handle network changes.

Network Watchdog

Explains the network watchdog timeout for routers to verify coordinator presence.

End Device Operation

Discover ZigBee Networks

Describes how end devices scan for and discover available ZigBee networks.

Join a Network

Details the process for an end device to send an association request and join a network.

Parent Child Relationship

Explains the parent-child relationship for end devices and message buffering.

End Device Capacity

Discusses the capacity of routers/coordinators to support end devices in a network.

Orphan Scans

Describes how end devices perform orphan scans to re-establish parent connectivity.

End Device Joining

Covers the commands controlling the end device joining process.

ZigBee Channel Scanning

Manage Multiple ZigBee Networks

Provides features for managing joining among multiple ZigBee networks.

Filter PAN ID

Configures the XBee to join a network with a specific fixed PAN ID.

Configure Security Keys

Ensures router/end device joins a ZigBee network with the same security key.

Prevent Unwanted Devices from Joining

Disables permit-joining to prevent unauthorized devices from joining a network.

Transmission, Addressing, and Routing

Addressing

Explains 64-bit device addresses and 16-bit network addresses used in ZigBee.

Data Transmission

Covers unicast and broadcast transmissions, including broadcast data transmission.

Binding Transmissions

Uses indirect addressing to send messages to other devices via binding tables.

Multicast Transmissions

Details multicast transmissions to destination devices with common group IDs.

RF Packet Routing

Explains ZigBee routing methods like AODV, Many-to-One, and Source Routing.

Transmission Timeouts

Describes unicast and extended timeouts for reliable data delivery to devices.

ZigBee Security

Security Modes

Outlines ZigBee security modes: residential, standard, and high security.

ZigBee Security Model

Explains ZigBee security application to Network and APS layers with AES encryption.

Implementing Security on the XBee/XBee-PRO ZigBee RF Module

Details how to enable security, set keys, and use a trust center for secure networks.

Network Commissioning and Diagnostics

Place Devices

Guidance on placing devices to establish reliable network links.

Test Links in a Network - Loopback Cluster

Describes using the loopback cluster for measuring network link quality.

Device Discovery

Explains network discovery using ND command and ZDO discovery methods.

Commissioning Pushbutton and Associate LED

Details features for device deployment aid: pushbutton and associate LED behaviors.

Binding

Covers binding request messages for establishing device-to-device communication.

Group Table API

Explains how to manage group tables using API commands for multicast addressing.

Manage End Devices

End Device Operation

Describes how end devices operate, including parent interaction and sleep modes.

Parent Operation

Details how parents manage child tables and buffer data for sleeping end devices.

Non-Parent Device Operation

Explains how devices handle transmissions to end devices differently.

End Device Configuration

Covers sleep modes (Pin, Cyclic) and related configuration commands.

Recommended Sleep Current Measurements

Provides steps for accurately measuring sleep currents and estimating battery life.

Router/Coordinator Configuration

Details configurations for buffering, polling timeouts, and adaptive polling for parents.

Putting It All Together

Provides examples for configuring sleep modes and related device parameters.

Analog and Digital I/O Lines

Configurable I/O Pins and Configuration Commands

Lists configurable I/O pins, their module pins, AT commands, and command ranges.

I/O Configuration

Explains how to enable analog or digital I/O functions on XBee pins using configuration commands.

I/O Sampling

Describes how to monitor and sample analog/digital I/O lines locally or remotely.

RSSI PWM

Explains using the RSSI/PWM pin to indicate received signal strength of the last packet.

PWM1

Details the configuration for DIO11/PWM1, providing a 50% duty cycle clock.

API Operation

API Frame Format

Describes the structure of API frames for modes with and without escaped characters.

Data Bytes That Need to Be Escaped:

Lists specific data bytes that require escaping in UART data frames to avoid interference.

Calculate and Verify Checksums

Explains how to calculate and verify the checksum for API frames to ensure data integrity.

API Examples

Provides examples of API frames for configuring devices and sending commands.

API Serial Exchanges

Illustrates API frame exchanges for AT commands, RF data, and remote AT commands.

Frame Descriptions

Describes various API frames including AT Command, Transmit Request, and Modem Status frames.

AT Commands

Addressing Commands

Details AT commands for setting destination addresses, network addresses, and identifiers.

Network Commands

Covers AT commands for configuring network parameters like channel and PAN ID.

Security Commands

Details AT commands for enabling encryption, setting security keys, and configuring options.

RF Interfacing Commands

Explains AT commands related to TX power level, power mode, and received signal strength.

Serial Interfacing Commands

Covers AT commands for API mode, baud rate, parity, and stop bits settings.

I/O Settings Commands

Details AT commands for configuring I/O sample rate, change detection, and pin functions.

Diagnostic Commands

Provides AT commands for reading firmware version, long version, and hardware version.

Command Mode Options

Details AT commands for managing command mode timeout, exit, guard times, and character.

Sleep Commands

Covers AT commands for configuring sleep modes, sleep periods, and wake delays.

Execution Commands

Explains AT commands for applying changes, performing scans, and resetting devices.

Module Support

XCTU Configuration Tool

Introduces the XCTU tool for configuring XBee devices and updating firmware.

Customizing XBee ZigBee Firmware

Discusses manufacturing devices with custom configurations or programming custom firmware.

XBee Bootloader

Explains the XBee bootloader and how to invoke it using module pins or XCTU.

Programming XBee Modules

Covers serial firmware updates using the XBee custom bootloader.

Writing Custom Firmware

Guides on developing custom firmware and cautions regarding JTAG interface usage.

Regulatory Compliance

Details FCC and European certifications and power output requirements.

Regulatory Information

United States (FCC)

Covers FCC compliance, labeling requirements, and FCC notices for XBee modules.

Europe (CE)

Details CE marking requirements, RF exposure, power specs, and compliance for European countries.

IC (Industry Canada)

Outlines Industry Canada labeling requirements and transmitter guidelines.

Australia (RCM)

Specifies requirements for RCM and R-NZ marks for products sold in Australia/New Zealand.

ANATEL (Brazil)

Covers Brazil ANATEL standards and required information for products containing the radio.

South Korea

Provides South Korean approval information and label requirements for XBee modules.

Migrating from XBee Through-hole to XBee Surface-mount Devices

Pin Mapping

Maps surface-mount pads to through-hole pins for migration between form factors.

Mounting

Describes mounting techniques and PCB footprint for XBee surface-mount devices.

Manufacturing Information

Recommended Solder Reflow Cycle

Lists recommended temperature settings and times for the solder reflow process.

Recommended Footprint

Provides recommended PCB footprint dimensions for surface-mounting XBee devices.

Flux and Cleaning

Recommends 'no clean' solder paste to eliminate cleaning steps and residual flux issues.

Reworking

Provides guidelines for rework procedures, voiding warranty, and handling device temperature.

Load ZigBee Firmware on 802.15.4 Devices

Background

Explains hardware compatibility for loading ZigBee firmware on 802.15.4 modules.

Load ZB Firmware

Provides step-by-step instructions for loading ZigBee firmware using XCTU.

Definitions

ZigBee Node Types

Defines Coordinator, Router, and End Device node types in a ZigBee network.

ZigBee Protocol

Defines key ZigBee terms like PAN, Joining, Network Address, and Operating Channel.

Related product manuals