Digi PS2CSM Product Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Control Unit
  5. PS2CSM
  6. Product manual

Digi PS2CSM Product Manual

Zb rf modules
Hide thumbs Also See for PS2CSM:
Table of Contents

Advertisement

Quick Links

Download this manual
®
XBee
/XBee-PRO
ZigBee RF Modules by Digi International
Models: XBEE S2C, PS2CSM, S2CTH, PS2CTH, Legacy PRO S2C
Hardware: S2C
Firmware: 401x, 402x, 403x, 404x, 405x
®
ZB RF Modules
Digi International Inc.
11001 Bren Road East
Minnetonka, MN 55343
877 912-3444 or 952 912-3444
www.digi.com
90002002_P
10/10/2014

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Related Manuals for Digi PS2CSM

Summary of Contents for Digi PS2CSM

  • Page 1 ® ® XBee /XBee-PRO ZB RF Modules ZigBee RF Modules by Digi International Models: XBEE S2C, PS2CSM, S2CTH, PS2CTH, Legacy PRO S2C Hardware: S2C Firmware: 401x, 402x, 403x, 404x, 405x Digi International Inc. 11001 Bren Road East Minnetonka, MN 55343 877 912-3444 or 952 912-3444 www.digi.com...
  • Page 2 ZigBee alliance. All other trademarks mentioned in this document are the property of their respective owners. Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International.

  • Page 3: Table Of Contents

    XBee ZigBee Modes of Operation 38 Joining a Network 54 Idle Mode 38 Parent Child Relationship 54 Transmit Mode 38 End Device Capacity 54 Receive Mode 39 Authentication 54 Command Mode 39 Persistent Data 54 Sleep Mode 40  © 2014 Digi International Inc.      3...
  • Page 4 Group Table API 91 Transmission Timeouts 75 Managing End Devices 101 Unicast Timeout 75 Extended Timeout 75 End Device Operation 101 Transmission Examples 76 Parent Operation 101 End Device Poll Timeouts 102 XBee ZigBee Security 78 Packet Buffer Usage 102  © 2014 Digi International Inc.      4...
  • Page 5 I/O Configuration 114 XCTU Configuration Tool 162 I/O Sampling 115 Customizing XBee ZB Firmware 162 Queried Sampling 116 Design Considerations for Digi Drop-In Networking Periodic I/O Sampling 116 Change Detection Sampling 116 XBee Bootloader 162 RSSI PWM 117 Programming XBee Modules 163...
  • Page 6 Antennas 173 Canada (IC) 173 Transmitters for Detachable Antennas 173 Detachable Antenna 173 Australia (RCM/C-Tick) 174 Appendix B:Migrating from XBee Through-hole to XBee Surface Mount Modules 175 Appendix C:Manufacturing Information 178 Appendix D:Warranty Information 181 Appendix E:Definitions 182  © 2014 Digi International Inc.      6...

  • Page 7: 1. Overview Of The Xbee Zigbee Rf Module

    • Manufactured under ISO 9001:2000 registered standards • XBee/XBee-PRO ZB RF Modules are optimized for use in US, Canada, Australia, Europe (XBee only) and Japan (XBee only). Contact Digi for a complete list of agency approvals What’s New in 40xx Firmware •...

  • Page 8: Specifications Of The Xbee Zigbee Rf Module

    15 Direct Sequence Channels Interface Immunity DSSS (Direct Sequence Spread Spectrum) Channels 11 to 26 11 to 25 Addressing Options PAN ID and Addresses, Cluster IDs and Endpoints (optional) Interface Options UART 1 Mbps maximum (burst) 5 Mbps maximum (burst) © 2014 Digi International Inc.      8...

  • Page 9: Agency Approvals

    Agency Approvals XBee-PRO (Surface Approval XBee (Surface Mount) XBee (Through-hole) XBee-PRO (Through-hole) Mount) United States (FCC FCC ID: MCQ-XBS2C FCC ID: MCQ-PS2CSM FCC ID: MCQ-S2CTH FCC ID: MCQ-PS2CTH Part 15.247) Industry Canada (IC) IC: 1846A-XBS2C IC: 1846A-PS2CSM IC: 1846A-S2CTH IC: 1846A-PS2CTH...

  • Page 10: Hardware Specifications For Programmable Variant

    Runtime current for 32k running at 20MHz +14mA Runtime current for 32k running at 1MHz +1mA Sleep current +0.5A typical For additional specifications see Freescale Datasheet and MC9SO8QE32 Manual Minimum Reset low pulse time for EM357 +26S VREF Range 1.8VDC to VCC © 2014 Digi International Inc.      10...

  • Page 11: Mechanical Drawings Of The Xbee Zigbee Rf Modules

    ® ® XBee /XBee‐PRO  ZB RF Modules  Mechanical Drawings of the XBee ZigBee RF Modules Mechanical drawings of the XBee®/XBee‐PRO® ZB  RF Modules. All dimensions are in inches. Mechanical drawings of the XBee/XBee‐PRO SMT model (antenna options not shown) .  © 2014 Digi International Inc.      11...
  • Page 12 ® ® XBee /XBee‐PRO  ZB RF Modules  Mechanical drawings of the XBee TH model © 2014 Digi International Inc.      12...
  • Page 13 ® ® XBee /XBee‐PRO  ZB RF Modules  Mechanical drawings of the XBee‐PRO TH model © 2014 Digi International Inc.      13...

  • Page 14: Pin Signals For The Xbee Zigbee Surface Mount Module

    • Signal Direction is specified with respect to the module • See Design Notes section below for details on pin connections • * Refer to the Writing Custom Firmware section for instructions on using these pins if JTAG functions are needed © 2014 Digi International Inc.      14...

  • Page 15: Pin Signals For The Xbee Zigbee Through-Hole Module

    AD2 / DIO2 / SPI_CLK Both Disabled Analog Input / GPIO / SPI Clock AD1 / DIO1 / SPI_ATTN Both Disabled Analog Input / GPIO / SPI Attention AD0 / DIO0 / CB Both Disabled Analog Input / GPIO / Commissioning Button © 2014 Digi International Inc.      15...

  • Page 16: Em357 Pin Mappings

    All unused pins should be left disconnected. All inputs on the radio can be pulled high or low with 30k internal pull-up or pull-down resistors using the PR and PD software commands. No specific treatment is needed for unused outputs. © 2014 Digi International Inc.      16...

  • Page 17: Board Layout

    PCB antenna modules. It should be noted that for optimal performance, this module should not be mounted on the RF Pad footprint described in the next section because the footprint requires a ground plane within the PCB Antenna keep out area. © 2014 Digi International Inc.      17...
  • Page 18 ® ® XBee /XBee‐PRO  ZB RF Modules  SMT Keepout Area © 2014 Digi International Inc.      18...
  • Page 19 ® ® XBee /XBee‐PRO  ZB RF Modules  TH Keepout Area © 2014 Digi International Inc.      19...
  • Page 20 (in this case, at least 0.050") from the microstrip to minimize their interaction. Implementing these design suggestions will help ensure that the RF Pad module performs to its specifications. PCB Layer 1 of RF Layout Example © 2014 Digi International Inc.      20...

  • Page 21: Module Operation For Programmable Variant

    Digi provides a bootloader that can take care of programming the processor over the air or through the serial interface. This means that over the air updates can be supported through an XMODEM protocol. The processor can also be programmed and debugged through a one wire interface BKGD (Pin 9/SMT, Pin 8/TH).
  • Page 22 ® ® XBee /XBee‐PRO  ZB RF Modules  Programmable Connections For SMT © 2014 Digi International Inc.      22...
  • Page 23 ® ® XBee /XBee‐PRO  ZB RF Modules  Programmable Connections For TH © 2014 Digi International Inc.      23...

  • Page 24: Xbee Programmable Bootloader

    BLResetCause is cleared and the application is started again. To prevent unexpected halting of the application, the application shall clear or decrement BLResetCause just before a pending reset. To disable this feature, the application shall clear BLResetCause at the start of the application. © 2014 Digi International Inc.      24...
  • Page 25 ® ® XBee /XBee‐PRO  ZB RF Modules  © 2014 Digi International Inc.      25...
  • Page 26 ® ® XBee /XBee‐PRO  ZB RF Modules  © 2014 Digi International Inc.      26...
  • Page 27 ® ® XBee /XBee‐PRO  ZB RF Modules  © 2014 Digi International Inc.      27...
  • Page 28 100 bytes including the terminating NULL character. During an update the bootloader erases the entire application from 0x8400 on. The last page has the vector table specifically the redirected reset vector. The version string pointer and reset vector are used to determine if the application is valid. © 2014 Digi International Inc.      28...
  • Page 29 Unassigned */ vDummyIsr, /* Int.no. 24 Vtpm1ovf (at F1F0) Unassigned */ vDummyIsr, /* Int.no. 25 Vtpm1ch2 (at F1F2) Unassigned */ vDummyIsr, /* Int.no. 26 Vtpm1ch1 (at F1F4) Unassigned */ vDummyIsr, /* Int.no. 27 Vtpm1ch0 (at F1F6) Unassigned */ © 2014 Digi International Inc.      29...

  • Page 30: Bootloader Menu Commands

    Bootloader Version BL032-2x0-025_064 only operates at 9600 baud on the local UART as well as communications to the EM357 Radio. A newer version of the Bootloader BL032-2x0-033_064 or newer BL032-2B0-XXX_064 has changed the baud rate to 115200 between the Programmable and the EM357 © 2014 Digi International Inc.      30...

  • Page 31: Firmware Updates

    Xmodem CRC transfer. Using XCTU or another terminal program, Select "XMODEM" file transfer. Select the Binary file to upload/transfer. Click Send to start the transfer. At the con- clusion of a successful transfer, the bootloader will jump to the newly loaded application. © 2014 Digi International Inc.      31...

  • Page 32: Output File Configuration

    0x0000 to the code space with the same number. (Often 0x00 or 0xFF) These extra bytes before the APP code starts will need to be deleted from the bin file before the file can be transferred to the bootloader. © 2014 Digi International Inc.      32...

  • Page 33: 2. Xbee Zigbee Rf Module Operation

    RS-232 or USB interface board), or through a Serial Peripheral Interface, which is a synchronous interface to be described later. Two Wire serial Interface (TWI) is also available, but not supported by Digi. For information on the TWI, see the EM357 specification.
  • Page 34 XBee and use the new configuration settings. If neither serial port is enabled, the module will not support serial operations and all communications must occur over the air. All data that would normally go to the serial port is discarded. © 2014 Digi International Inc.      34...

  • Page 35: Xbee Zigbee Serial Buffers

    The RTS and CTS module pins can be used to provide RTS and/or CTS flow control. CTS flow control provides an indication to the host to stop sending serial data to the module. RTS flow control allows the host to signal the © 2014 Digi International Inc.      35...

  • Page 36: Xbee Zigbee Break Control

    The module will send data frames to the application containing status packets; as well as source, and payload information from received data packets. © 2014 Digi International Inc.      36...
  • Page 37 If the above conditions do not apply (e.g. a sensor node, router, or a simple application), then transparent operation might be suitable. It is acceptable to use a mixture of devices running API mode and transparent mode in a network. © 2014 Digi International Inc.      37...

  • Page 38: Xbee Zigbee Modes Of Operation

    If route discovery fails to establish a route, the packet will be discarded. Transmit Mode Sequence Successful Transmission 16-bit Network Idle Mode Route Known? Transmit Data Address Known? Transmission 16-bit Network Route Discovery Address Discovery 16-bit Network Route Discovered? Address Discovered? Data Discarded © 2014 Digi International Inc.      38...

  • Page 39: Receive Mode

    For modified parameter values to persist in the module’s registry after a reset, changes must be saved to non-volatile memory using the WR (Write) Command. Otherwise, parameters are restored to previously saved values after the module is reset. © 2014 Digi International Inc.      39...

  • Page 40: Sleep Mode

    Sleep modes allow the RF module to enter states of low power consumption when not in use. XBee RF modules support both pin sleep (sleep mode entered on pin transition) and cyclic sleep (module sleeps for a fixed time). XBee sleep modes are discussed in detail in chapter 7. © 2014 Digi International Inc.      40...

  • Page 41: 3. Xbee Zigbee Networks

    •Selects a channel and PAN ID (both 64-bit and 16-bit) to start the network •Can allow routers and end devices to join the network •Can assist in routing data •Cannot sleep--should be mains powered •Can buffer RF data packets for sleeping end device children © 2014 Digi International Inc.      41...
  • Page 42 Smart Energy builds, EO should be changed from 02 to 08 when CE is set to 1. In general, when changing device types, it is the user's responsibility to ensure that parameters are set to be compatible with the new device type. © 2014 Digi International Inc.      42...

  • Page 43: Pan Id

    ZigBee stack that are not required in many cases. Skip this section if •The XBee does not need to interoperate or talk to non-Digi ZigBee devices •The XBee simply needs to send data between devices Read this section if •The XBee may talk to non-Digi ZigBee devices...
  • Page 44 Digi XBee ZB firmware operates on a private profile called the Digi Drop-In Networking profile. However, API mode can be used in many cases to talk to devices in public profiles or non-Digi private profiles. See the API Operations chapter for details.

  • Page 45: Zigbee Coordinator Operation

    The coordinator will retain this information indefinitely until it leaves the network. When the coordinator leaves a network and starts a new network, the previous PAN ID, operating channel, and child table data are lost. XBee ZigBee Coordinator Startup The following commands control the coordinator network formation process. © 2014 Digi International Inc.      45...

  • Page 46: Permit Joining

    The following mechanisms can restart the permit-joining timer: • Changing NJ to a different value (and applying changes with the AC or CN commands) • Pressing the commissioning button twice • Issuing the CB command with a parameter of 2 © 2014 Digi International Inc.      46...

  • Page 47: Resetting The Coordinator

    Each of the commands listed above can be read from any device on the network. (These parameters will be the same on all devices in the network.) After reading these commands from a device on the network, these parameter values should be programmed into the new coordinator using the following commands. © 2014 Digi International Inc.      47...

  • Page 48: Example: Starting A Coordinator

    The router evaluates each beacon received on the channel to determine if a valid PAN is found. A router considers a PAN to be valid if the PAN: •Has a valid 64-bit PAN ID (PAN ID matches ID if ID > 0) © 2014 Digi International Inc.      48...

  • Page 49: Joining A Network

    Set the scan duration, or time that the router will listen for beacons on each channel. Set the stack profile on the device. Enable or disable security in the network. This must be set to match the EE value (security policy) of the coordinator. © 2014 Digi International Inc.      49...

  • Page 50: Permit Joining

    If a router may physically move out of range of the network it initially joined, the application should include provisions to detect if the router can still communicate with the original network. If communication with the © 2014 Digi International Inc.      50...
  • Page 51 Anytime a router receives valid data from the coordinator or data collector, it will clear the watchdog timeouts counter and restart the watchdog timer. The watchdog timer (NW command) is settable to several days. The network watchdog feature is disabled by default (NW defaults to 0). © 2014 Digi International Inc.      51...

  • Page 52: Leaving A Network

    The Network Locator option, if enabled (ATDO80), modifies the behavior of the JV and NW options. Failure to communicate with the Coordinator does not result in the radio leaving the network, but instead the radio starts a search for the network across the channels of the Search Channel mask (SC). If the © 2014 Digi International Inc.      52...

  • Page 53: Resetting The Router

    If scanning all SC channels fails to discover a valid PAN, XBee ZB modules will attempt to enter a low power state and will retry scanning all SC channels after the module wakes from sleeping. If the module cannot enter a low power state, it will retry scanning all channels, similar to the router. To meet ZigBee Alliance © 2014 Digi International Inc.      53...

  • Page 54: Joining A Network

    64-bit address. If an entry is found with a matching 64-bit address, the device sends a coordinator realignment command to the end device that includes the end device's 16-bit address, 16-bit PAN ID, operating channel, and the parent's 64-bit and 16-bit addresses. © 2014 Digi International Inc.      54...

  • Page 55: Xbee Zigbee End Device Joining

    If the end device does not receive an acknowledgment for 3 consecutive poll requests, it considers itself disconnected from its parent and will attempt to discover and join a valid ZigBee network. See "Managing End Devices" chapter for details. © 2014 Digi International Inc.      55...

  • Page 56: Resetting The End Device

    SC bitmask until a valid PAN is found or all channels have been scanned. Once all channels have been scanned, the next join attempt will start scanning on the lowest channel specified in the SC command bitmask. © 2014 Digi International Inc.      56...

  • Page 57: Managing Multiple Zigbee Networks

    If the application does not receive the expected response message after joining, the application could force the XBee to leave and continue scanning (see NR parameter). © 2014 Digi International Inc.      57...

  • Page 58: 4. Transmission, Addressing, And Routing

    Layers - In Depth" in chapter 3.) Application layer addressing allows data transmissions to be addressed to specific profile IDs, cluster IDs, and endpoints. Application layer addressing is useful if an application must • Interoperate with other ZigBee devices outside of the Digi application profile • Utilize service and network management capabilities of the ZDO •...

  • Page 59: Broadcast Transmissions

    As mentioned previously, each device in a ZigBee network has both a 16-bit (network) address and a 64-bit (extended) address. The 64-bit address is unique and assigned to the device during manufacturing, and the 16-bit address is obtained after joining a network. The 16-bit address can also change under certain conditions. © 2014 Digi International Inc.      59...
  • Page 60 (unknown) in the API transmit frame. The API provides indication of a remote device's 16-bit address in the following frames: • All receive data frames • Rx Data (0x90) • Rx Explicit Data (0x91) • I/O Sample Data (0x92) © 2014 Digi International Inc.      60...

  • Page 61: Binding Transmissions

    ZigBee feature called fragmentation that allows a single large data packet to be broken up into multiple RF transmissions and reassembled by the receiver before sending data out its serial port. This is shown in the image below. © 2014 Digi International Inc.      61...

  • Page 62: Data Transmission Examples

    Alternatively, if the coordinator's 64-bit address is known, DH and DL can be set to the coordinator's 64-bit address. Suppose the coordinator's address is 0x0013A200404A2244. 1. Enter command mode ('+++') 2. After receiving an OK\r, issue the following commands: a. ATDH13A200\r b. ATDL404A2244\ c. ATCN\r © 2014 Digi International Inc.      62...
  • Page 63 If the explicit transmit frame is used, the cluster ID should be set to 0x0011, the profile ID to 0xC105, and the source and destination endpoints to 0xE8 (recommended defaults for data transmissions in the Digi profile.) The same transmission could be sent using the following explicit transmit frame: 7E 00 15 11 01 0000 0000 0000 0000 FFFE E8 E8 0011 C105 00 00 31 18 Notice the 16-bit address is set to 0xFFFE.

  • Page 64: Rf Packet Routing

    For example, consider a network of two neighboring devices that send periodic link status messages. Suppose that the output power of device A is +18dBm, and the output power of device B is +3dBm (considerably less than the output power of device A). The link status messages might indicate the following: © 2014 Digi International Inc.      64...

  • Page 65: Aodv Mesh Routing

    (hops) in a network to route data from a source to a destination. Routers and coordinators can participate in establishing routes between source and destination devices using a process called route discovery. The Route discovery process is based on the AODV (Ad-hoc On-demand Distance Vector routing) protocol. Sample Transmission Through a Mesh Network © 2014 Digi International Inc.      65...
  • Page 66 If the path cost stored in the route request is better than any previously received, the destination node will transmit a route reply packet to the node that originated the route request. Intermediate nodes receive and forward the route reply packet to the source node (the node that originated route request). © 2014 Digi International Inc.      66...

  • Page 67: Many-To-One Routing

    Applications that require multiple data collectors can also use many-to-one routing. If more than one data collector device sends a many-to-one broadcast, devices will create one reverse routing table entry for each collector. © 2014 Digi International Inc.      67...

  • Page 68: High/Low Ram Concentrator Mode

    16-bit address of each hop in the route. The data collector can store the routing information and retrieve it later to send a source routed packet to the remote. This is shown in the images below. © 2014 Digi International Inc.      68...
  • Page 69 When a data collector receives a route record, it sends it out the serial port as a Route Record Indicator API frame (0xA1). To use source routing, the application should receive these frames and store the source route information. © 2014 Digi International Inc.      69...
  • Page 70 It is possible in a network to have an existing source route fail (i.e. a device in the route moves or goes down, etc.). If a device goes down in a source routed network, all routes that used the device will be broken. © 2014 Digi International Inc.      70...

  • Page 71: Encrypted Transmissions

    NP returns 84 bytes, and a source route must traverse 3 intermediate hops (3 16-bit addresses), the total number of bytes that can be sent in one RF packet is 78. •Enabling APS encryption (API tx option bit set) will reduce the number of payload bytes by 4. © 2014 Digi International Inc.      71...

  • Page 72: Throughput

    ZigBee Device Objects (ZDO) The ZigBee Device Objects (ZDO) is supported to some extent on all ZigBee devices. The ZDO is an endpoint that implements services described in the ZigBee Device Profile in the ZigBee specification. Each service has an © 2014 Digi International Inc.      72...

  • Page 73: Sending A Zdo Command

    7E 0016 11 01 0013A200 40401234 FFFE 00 00 0031 0000 00 00 76 00 CE 0x0016 - length 0x11 - Explicit transmit request 0x01 - frame ID (set to a non-zero value to enable the transmit status message, or set to 0 to disable) © 2014 Digi International Inc.      73...
  • Page 74 All multi-byte fields in the API payload of a ZDO command must have their data inserted in little endian byte order. Also recall that the AO command must be set correctly on an API device to enable the explicit API receive frames in order to receive the ZDO response. © 2014 Digi International Inc.      74...

  • Page 75: Transmission Timeouts

    3 * ((50 * NH) + (1.2 * SP)) The SP value in both equations must be entered in millisecond units. (The SP command setting uses 10ms units and must be converted to milliseconds to be used in this equation.) © 2014 Digi International Inc.      75...

  • Page 76: Transmission Examples

    0xFFFE - Required 16-bit address to send broadcast transmission. 0x00 - Broadcast radius (0 = max hops) 0x00 - Tx options 0x54 78 44 61 74 61 - ASCII representation of "TxData" string 0xAD - Checksum (0xFF - SUM (all bytes after length)) © 2014 Digi International Inc.      76...
  • Page 77 Setting AO=1 is required for the XBee to use the explicit receive API frame (0x91) when RF data packets are received. This is required if the application needs indication of source or destination endpoint, cluster ID, and/or profile ID values used in received ZigBee data packets. ZDO messages can only be received if AO=1. © 2014 Digi International Inc.      77...

  • Page 78: 5. Xbee Zigbee Security

    Network encryption is not applied to MAC layer transmissions such as beacon transmissions, etc. If security is enabled in a network, all data packets will be encrypted with the network key. Packets are encrypted and authenticated using 128-bit AES. This is shown in the figure below. © 2014 Digi International Inc.      78...

  • Page 79: Frame Counter

    APS security can be applied on a packet-by-packet basis. APS security cannot be applied to broadcast transmissions. If APS security is enabled, packets are encrypted and authenticated using 128-bit AES. This is shown in the figure below: © 2014 Digi International Inc.      79...

  • Page 80: Message Integrity Code

    APS encryption is used. Network and APS Layer Encryption Network and APS layer encryption can both be applied to data. The following figure demonstrates the authentication and encryption performed on the final ZigBee packet when both are applied. © 2014 Digi International Inc.      80...

  • Page 81: Trust Center

    If security is enabled in the XBee ZB firmware, devices acquire the network key when they join a network. Data transmissions are always encrypted with the network key, and can optionally be end-to-end encrypted with the APS link key. The following sections discuss the security settings and options in the XBee ZB firmware. © 2014 Digi International Inc.      81...

  • Page 82: Enabling Security

    The trust center also has the ability to update or change the network key on the network. In ZB firmware, a secure network can be established with or without a trust center. Network and APS layer encryption are supported if a trust center is used or not. © 2014 Digi International Inc.      82...

  • Page 83: Xbee Security Examples

    (KY) when the devices joined. Example 2: Forming a network with security (obtaining keys during joining) 1. Start a coordinator with the following settings: a. ID=2235 b. EE=1 c. NK=0 d. KY=0 © 2014 Digi International Inc.      83...
  • Page 84 And since KY was set to 0 on all devices, the network key was sent unencrypted ("in the clear") when the devices joined. This approach introduces a security vulnerability into the network and is not recommended. © 2014 Digi International Inc.      84...

  • Page 85: 6. Network Commissioning And Diagnostics

    (0 for the coordinator, or the 64-bit address of the remote). After exiting command mode, any received serial characters will be transmitted to the remote device, and returned to the sender. © 2014 Digi International Inc.      85...

  • Page 86: Rssi Indicators

    Device Discovery Network Discovery The network discovery command can be used to discover all Digi modules that have joined a network. Issuing the ND command sends a broadcast node discovery command throughout the network. All devices that receive the command will send a response that includes the device’s addressing information, node identifier string (see NI command), and other relevant information.

  • Page 87: Commissioning Pushbutton

    Button presses may be simulated in software using the ATCB command. ATCB should be issued with a parameter set to the number of button presses to execute. (e.g. sending ATCB1 will execute the action(s) associated with a single button press.) © 2014 Digi International Inc.      87...

  • Page 88: Associate Led

    A single comm issioning button press when the device has not joined a network that causes the associate pin to blink to indicate the AI Code where : AI = # blinks + 0x20. In this example, AI = 0x22. © 2014 Digi International Inc.      88...

  • Page 89: Binding

    All devices that receive this transmission blink their associate pin rapidly for one second if the associate LED functionality is enabled. (D5 = 1) Binding There are three binding request messages supported by the Digi XBee firmware: End Device Bind, Bind, and Unbind. End_Device_Bind_req The End Device Bind request (ZDO cluster 0x0020) is described in the ZigBee Specification in section 2.4.3.2.1.
  • Page 90 C sends responses to the original End_Device_Bind_req messages. R1-<C End_Device_Bind_rsp R2-<C End_Device_Bind_rsp End Device Binding Sequence (Removal) Here is an example of a correctly formatted End_Device_Bind_req (ZDO cluster 0x0020) using a Digi 0x11 Explicit API Frame: The frame as a bytelist: 7e002811010000000000000000fffe000000200000000001f2995cb5474000a21300e605c10101000102004 Same frame broken into labeled fields. Note the multibyte fields are represented in big-endian format.

  • Page 91: Group Table Api

    ZigBee Cluster Library Groups Cluster (0x0006) with ZCL commands. The Digi ZigBee XBee firmware is intended to work with an external processor where a Public Application Profile with endpoints and clusters is implemented, including a Groups Cluster. The ZigBee XBee firmware should be configured to forward all ZCL commands addressed to this Group Cluster out the UART (see ATAO3).
  • Page 92 The response in terms of Preamble, ZCL Header, and ZCL payload: Preamble = "910013a2004047b55cfffee7e68006c10500" The packet has its endpoint values reversed from the request, and the clusterID is 0x8006 indicating a Group cluster response. ZCL_header = "09 ee 00" © 2014 Digi International Inc.      92...
  • Page 93 The response in raw hex byte form, consisting of two packets: 7e001d910013a2004047b55cfffee7e68006c1050009ee01003412044142434424 7e00078b01fffe00000076 The command response in decoded form: ZigBee Explicit Rx Indicator API 0x91 64DestAddr 0x0013A2004047B55C 16DestAddr 0xFFFE SrcEP 0xE7 DestEP 0xE6 ClusterID 0x8006 ProfileID 0xC105 Options 0x00 RF_Data 0x09EE010034120441424344 © 2014 Digi International Inc.      93...
  • Page 94 The first byte is the group count. If it is zero, then all groupIDs with an endpoint value which matches the given endpoint parameter will be returned in the response. The example packet in raw hex byte form: 7e001811010013a2004047b55cfffee6e70006c105000001ee020019 © 2014 Digi International Inc.      94...
  • Page 95 The packet is addressed to the local node, using a source endpoint of 0xE6, clusterID of 0x0006, and profileID of 0xC105. The destination endpoint E7 is the endpoint parameter for the "Get Group Membership" command. ZCL_header = "01 ee 02" © 2014 Digi International Inc.      95...
  • Page 96 FrameId value in the original command request had been zero, or if no space was available in the transmit UART buffer, then no Tx Status message would occur. ZigBee Tx Status API 0x8B FrameID 0x01 16DestAddr 0xFFFE Transmit Retries 0x00 Delivery Status 0x00 Discovery Status 0x00 Success © 2014 Digi International Inc.      96...
  • Page 97 The first field is a frame control field which specifies a Cluster Specific command (0x01) using a Server- >Client direction (0x08). The second field is a transaction sequence number which is used to associate the response with the command request. The third field is the command identifier "Remove Group" (0x03) [10]. ZCL_payload = "00 3412" © 2014 Digi International Inc.      97...
  • Page 98 The command response in decoded form: ZigBee Explicit Rx Indicator API 0x91 64DestAddr 0x0013A2004047B55C 16DestAddr 0xFFFE SrcEP 0xE7 DestEP 0xE6 ClusterID 0x8006 ProfileID 0xC105 Options 0x00 RF_Data 0x09ee0400 The response in terms of Preamble, ZCL Header, and ZCL payload. Preamble = "910013a2004047b55cfffee7e68006c10500" © 2014 Digi International Inc.      98...
  • Page 99 Frame Control Field of the ZCL Header 0x8b EMBER_ZCL_STATUS_NOT_FOUND: An attempt at Get Group Membership or Remove Group could not find a matching entry in the group table A full set of status codes appears in the documentation [4]. © 2014 Digi International Inc.      99...
  • Page 100 [6] View Group Response, section 3.6.2.3.2. [7] Get Group Membership Command, section 3.6.2.2.5. [8] Get Group Membership Response, section 3.6.2.3.3. [9] Remove Group Command, section 3.6.2.2.6. [10] Remove Group Response, section 3.6.2.3.4. [11] Remove All Groups Command, section 3.6.2.2.7. © 2014 Digi International Inc.      100...

  • Page 101: 7. Managing End Devices

    The data packet will remain buffered until a timeout expires, or until the end device sends a poll request to retrieve the data. © 2014 Digi International Inc.      101...

  • Page 102: End Device Poll Timeouts

    However, since end devices may sleep for some time, unicast transmissions to end devices use an extended timeout mechanism in order to allow enough time for the end device to wake and receive the data transmission from its parent. © 2014 Digi International Inc.      102...

  • Page 103: Xbee End Device Configuration

    For example, if the module has not joined a network and Sleep_RQ is asserted (high), the module will sleep once the current join attempt completes (i.e. when scanning for a valid network completes). The module will wake from pin sleep when the Sleep_RQ pin is de-asserted (low). © 2014 Digi International Inc.      103...
  • Page 104 ® ® XBee /XBee‐PRO  ZB RF Modules                    XBee SMT Pin Sleep Pins XBee TH Pin Sleep Pins Pin Sleep Waveforms In the figure above, t and t represent the following events: • t - Time when Sleep_RQ is asserted (high) © 2014 Digi International Inc.      104...

  • Page 105: Cyclic Sleep

    The On/Sleep line is asserted (high) when the module wakes, and is de-asserted (low) when the module sleeps. If hardware flow control is enabled (D7 command), the CTS pin will assert (low) when the module wakes and can receive serial data, and de-assert (high) when the module sleeps. © 2014 Digi International Inc.      105...
  • Page 106 •T1 - Time when the module wakes from cyclic sleep •T2 - Time when the module returns to sleep •T3 - Later time when the module wakes from cyclic sleep The wake time and sleep time are configurable with software commands as described in the sections below. © 2014 Digi International Inc.      106...
  • Page 107 (default), the On/Sleep line will be set high each time the XBee wakes from sleep. Otherwise, if SN is greater than 1, the On/Sleep line will only be set high if RF data is received, or after SN wake cycles occur. © 2014 Digi International Inc.      107...

  • Page 108: Transmitting Rf Data

    In pin sleep mode, the end device polls every 100ms while the Sleep_RQ pin is de-asserted (low). In cyclic sleep mode, the end device will only poll once before returning to sleep unless the sleep timer © 2014 Digi International Inc.      108...

  • Page 109: I/O Sampling

    NJ=0xFF, the device will attempt to join using association. XBee Router/Coordinator Configuration XBee routers and coordinators may require some configuration to ensure the following are set correctly: • RF packet buffering timeout • Child poll timeout © 2014 Digi International Inc.      109...

  • Page 110: Rf Packet Buffering Timeout

    The transmission timeout per attempt is: 3 * ((unicast router timeout) + (end device sleep time)), or 3 * ((50 * NH) + (1.2 * SP)), where SP is measured in 10ms units. © 2014 Digi International Inc.      110...

  • Page 111: Putting It All Together

    SM = 4 (cyclic sleep) or 5 (cyclic sleep, pin wake) SP = 0x7D0 (2000 decimal). This causes the end device to sleep for 20 seconds. SN = 1 SO = 0 ST = 0x7D0 (2000 decimal). This sets the sleep timer to 2 seconds. © 2014 Digi International Inc.      111...
  • Page 112 This will ensure the parent does not timeout the end device from its child table too quickly. The SI command can optionally be sent to the end device to cause it to sleep before the sleep timer expires. © 2014 Digi International Inc.      112...

  • Page 113: 8. Xbee Analog And Digital I/O Lines

    AT Command Command Range DIO13/DOUT 0, 1, 3-5 DIO14/DIN/nCONFIG 0, 1, 3-5 DIO12/PWM2/SWDIO/ 0, 1, 3-5 SPI_MISO DIO10/PWM RSSI/DAC0 0, 1, 3-5 DIO11/PWM1/DAC1 0, 1, 3-5 DIO8/nDTR/SLP_RQ 0, 1, 3-5 DIO4/SPI_MOSI 0, 1, 3-5 DIO7/nCTS 0, 1, 3-7 © 2014 Digi International Inc.      113...

  • Page 114: I/O Configuration

    • PD determines the pull direction. It only applies when the corresponding bit in PR is set. The bit in PD should be set to enable an internal pull-up resistor. It should be cleared to enable an internal pull-down resistor © 2014 Digi International Inc.      114...

  • Page 115: I/O Sampling

    Following the digital I/O data (if any), each enabled analog channel will return 2 bytes. The data starts with AIN0 and continues sequentially for each enabled analog input channel up to AIN3, and the supply voltage (if enabled) at the end. © 2014 Digi International Inc.      115...

  • Page 116: Queried Sampling

    If one or more bits in IC is set, an I/O sample will be transmitted as soon as a state change is observed in one of the monitored digital IO lines. Change detection samples are transmitted to the 64-bit address specified by DH and DL. © 2014 Digi International Inc.      116...

  • Page 117: Rssi Pwm

    32,787 Hz, which is a period of 30.5 s. The main purpose of the PWM output is to provide a clock for the PLUS processor, although it may also be used for other purposes. *When this feature is enabled, the RSSI PWM output is automatically disabled, even if it is configured. © 2014 Digi International Inc.      117...

  • Page 118: 9.  Xbee Zigbee Api Operation

    Data Frame. Note that Digi may add new API frames to future versions of firmware, so build into your software interface the ability to filter out additional API frames with unknown Frame Types.
  • Page 119 ZigBee IO Data Sample Rx Indicator 0x92 XBee Sensor Read Indicator (AO=0) 0x94 Node Identification Indicator (AO=0) 0x95 Remote Command Response 0x97 Extended Modem Status 0x98 Over-the-Air Firmware Update Status 0xA0 Route Record Indicator 0xA1 Many-to-One Route Request Indicator 0xA3 © 2014 Digi International Inc.      119...

  • Page 120: Api Examples

    0xFFFE = 16- bit Destination Address 0x02 = Apply Changes (Remote Command Options) 0x4431 = AT command ('D1') 0x03 = Command Parameter (the parameter could also be sent as 0x0003 or 0x00000003) 0x70 = Checksum © 2014 Digi International Inc.      120...

  • Page 121: Api Serial Port Exchanges

    The following image shows the API frame exchanges that take place at the serial port when sending a remote AT command. A remote command response frame is not sent out the serial port if the remote device does not receive the remote command. © 2014 Digi International Inc.      121...

  • Page 122: Source Routing

    Used to query or set module parameters on the local device. This API command applies changes after executing the command. (Changes made to module parameters take effect once changes are applied.) The API example below illustrates an API frame when modifying the NJ parameter value of the module © 2014 Digi International Inc.      122...

  • Page 123: At Command - Queue Parameter Value

    0x0000. For all other transmissions, setting the 16-bit address to the correct 16-bit address can help improve performance when transmitting to multiple destinations. If a 16-bit address is not known, this field should be set to 0xFFFE (unknown). The Transmit Status frame (0x8B) will indicate the discovered 16-bit address, if successful. © 2014 Digi International Inc.      123...
  • Page 124 Example: The example above shows how to send a transmission to a module where escaping is disabled (AP=1) with destination address 0x0013A200 40014011, payload "TxData1B". If escaping is enabled (AP=2), the frame should look like: 0x7E 0x00 0x16 0x10 0x01 0x00 0x7D 0x33 0xA2 0x00 0x40 0x0A 0x01 0x27 © 2014 Digi International Inc.      124...

  • Page 125: Explicit Addressing Zigbee Command Frame

    (recommended). This parameter is only used for broadcast transmissions. The maximum number of payload bytes can be read with the NP command. Note: If source routing is used, the RF payload will be reduced by two bytes per intermediate hop in the source route. © 2014 Digi International Inc.      125...
  • Page 126 0xFF - the 8 bit sum of bytes from offset 3 to this byte. Example: Send a data transmission to the coordinator (64-bit address of 0x00s) using a source endpoint of 0xA0, destination endpoint 0xA1, cluster ID =0x1554, and profile ID 0xC105. Payload will be "TxData". © 2014 Digi International Inc.      126...

  • Page 127: Remote At Command Request

    Example: Send a remote command to change the broadcast hops register on a remote device to 1 (broad- casts go to 1-hop neighbors only), and apply changes so the new configuration value immediately takes effect. In this example, the 64-bit address of the remote is 0x0013A200 40401122, and the destination 16- bit address is unknown. © 2014 Digi International Inc.      127...

  • Page 128: Create Source Route

    If device E has the 64-bit and 16-bit addresses of 0x0013A200 40401122 and 0x3344, and if devices B, C, and D have the following 16-bit addresses: B = 0xAABB C = 0xCCDD D = 0xEEFF The example above shows how to send the Create Source Route frame to establish a source route between A and E. © 2014 Digi International Inc.      128...

  • Page 129: At Command Response

    0x11 = Modem configuration changed while join in progress 0x80+ = Ember ZigBee stack error Checksum 5 0x6F 0xFF - the 8 bit sum of bytes from offset 3 to this byte. Note: New modem status codes may be added in future firmware releases. © 2014 Digi International Inc.      129...

  • Page 130: Zigbee Transmit Status

    0xFF - the 8 bit sum of bytes from offset 3 to this byte. Example: Suppose a unicast data transmission was sent to a destination device with a 16-bit address of 0x7D84. (The transmission could have been sent with the 16-bit address set to 0x7D84 or 0xFFFE.) © 2014 Digi International Inc.      130...

  • Page 131: Zigbee Receive Packet

    Example: Suppose a device with a 64-bit address of 0x0013A200 40522BAA, and 16-bit address 0x7D84 sends a unicast data transmission to a remote device with payload "RxData". If AO=0 on the receiving device, it would send the above example frame out its serial port. © 2014 Digi International Inc.      131...

  • Page 132: Zigbee Explicit Rx Indicator

    "RxData". Suppose the transmission was sent with source and destination endpoints of 0xE0, cluster ID=0x2211, and profile ID=0xC105. If AO=1 on the receiving device, it would send the above frame out its serial port. © 2014 Digi International Inc.      132...

  • Page 133: Zigbee Io Data Sample Rx Indicator

    2-byte value indicating the A/D measurement 22 0x25 of that input. Analog samples are ordered sequentially from AD0/DIO0 to AD3/DIO3, to the supply voltage. Checksum 23 0xF5 0xFF - the 8 bit sum of bytes from offset 3 to this byte. © 2014 Digi International Inc.      133...

  • Page 134: Xbee Sensor Read Indicator

    (low) the IO sample is shown in the API example in the table above. XBee Sensor Read Indicator Frame Type: 0x94 When the module receives a sensor sample (from a Digi 1-wire sensor adapter), it is sent out the serial port using this message type (when AO=0). Frame Fields...
  • Page 135 Voutput = (82 * 5.1 / 255) = 1.64 Temperature = (362 / 16) = 22.625°C Relative H = (161.2903 * ((1.64/4.68) - 0.16)) = 161.2903 * (0.19043) = 30.71% True H = (30.71 / (1.0546 - (0.00216 * 22.625))) = (30.71 / 1.00573) = 30.54% © 2014 Digi International Inc.      135...

  • Page 136: Node Identification Indicator

    30 0x01 command). 3 = Frame sent after power cycle event occurred (see JN command). 31 0xC1 Digi Profile ID Set to Digi's application profile ID. 32 0x05 33 0x10 Manufacturer ID Set to Digi's Manufacturer ID. 34 0x1E Checksum 35 0x1B 0xFF - the 8 bit sum of bytes from offset 3 to this byte.

  • Page 137: Remote Command Response

    If the Verbose Join option (DC10) is enabled, trace messages will be serially transmitted to describe what is happening inside the radio during association. Warning: This option is provided for diagnostic purposes. It should not be left enabled, particularly when operating in AT Command mode, because its messages will be interspersed with received data. © 2014 Digi International Inc.      137...
  • Page 138 Joining An association request is being made. 16 bit 4med' a network, or a panid(2) Router/End Device has 'joined' a network. 64 bit PAN Identifier for extendedPanId(8) network Joined - Coordinator "Formed:", Router/ 0x03 Joined End Device "Joined" © 2014 Digi International Inc.      138...
  • Page 139 The following is an example of a successful association where Verbose Join was enabled in AT Command Mode. Note that comments are interspersed with the trace messages to explain the content, and are preceded by an ellipsis "...". Example: +++OK atid3151 OK © 2014 Digi International Inc.      139...

  • Page 140: Over-The-Air Firmware Update Status

    The Over-the-Air Firmware Update Status frame provides a status indication of a firmware update transmission attempt. If a query command (0x01 0x51) is sent to a target with a 64-bit address of 0x0013A200 40522BAA through an updater with 64-bit address 0x0013A200403E0750 and 16-bit address 0x0000, the following is the expected response. © 2014 Digi International Inc.      140...
  • Page 141 75 seconds, the target will timeout and accept new query messages. If a query returns a 0x51 (QUERY) status, then the target's bootloader is not active and will not respond to query messages. © 2014 Digi International Inc.      141...

  • Page 142: Route Record Indicator

    If device E has the 64-bit and 16-bit addresses of 0x0013A200 40401122 and 0x3344, and if devices B, C, and D have the following 16-bit addresses: B = 0xAABB C = 0xCCDD D = 0xEEFF The data collector will send the above API frame out its serial port. © 2014 Digi International Inc.      142...

  • Page 143: Many-To-One Route Request Indicator

    Example: Suppose a device with a 64-bit address of 0x0013A200 40401122 and 16-bit address of 0x0000 sends a many-to-one route request. All remote routers operating in API mode that receive the many-to-one broadcast would send the above example API frame out their serial port. © 2014 Digi International Inc.      143...

  • Page 144: Sending Zigbee Device Objects (Zdo) Commands With The Api

    For an API XBee to receive ZDO responses, the AO command must be set to 1 to enable the explicit receive API frame. The following table shows how the Explicit API frame can be used to send an "Active Endpoints" request to discover the active endpoints on a device with a 16-bit address of 0x1234. © 2014 Digi International Inc.      144...
  • Page 145 [16-bit NwkAddrOfInterest] 25 0x12 Note the 16-bit address in the API example (0x1234) is sent in little endian byte order (0x3412). 0xFF minus the 8 bit sum of bytes from offset 3 to this Checksum 26 0xA6 byte. © 2014 Digi International Inc.      145...

  • Page 146: Sending Zigbee Cluster Library (Zcl) Commands With The Api

    Note: When sending ZCL commands, the AO command should be set to 1 to enable the explicit receive API frame. This will provide indication of the source 64- and 16-bit addresses, cluster ID, profile ID, and endpoint information for each received packet. This information is required to properly decode received data. © 2014 Digi International Inc.      146...
  • Page 147 (0x0300). All multi-byte ZCL header 27 0x00 and payload values must be sent in little endian byte order. 0xFF minus the 8 bit sum of bytes from offset 3 to this Checksum 28 0xFA byte. © 2014 Digi International Inc.      147...

  • Page 148: Sending Public Profile Commands With The Api

    Note: When sending public profile commands, the AO command should be set to 1 to enable the explicit receive API frame. This will provide indication of the source 64- and 16-bit addresses, cluster ID, profile ID, and end- point information for each received packet. This information is required to properly decode received data. © 2014 Digi International Inc.      148...
  • Page 149 Since the frame control "frame type" bits are 01, this byte specifies a cluster-specific command. Command ID 0x00 25 0x00 in the Demand Response and Load Control cluster is a Load Control Event command. (See Smart Energy specification.) © 2014 Digi International Inc.      149...
  • Page 150 0 - The manufacturer code field is omitted from the ZCL Frame Header. Direction 1 - The command is being sent from the server side to the client side. Disable Default Response 0 - Default response not disabled Reserved Set to 0. © 2014 Digi International Inc.      150...

  • Page 151: 10.  Xbee Command Reference Tables

    0 - 0xFF 0xE8 transparent mode.The default value 0xE8 (Data endpoint) is the Digi data endpoint Destination Endpoint. Set/read Zigbee application layer destination ID value. This value will be used as the destination endpoint all data transmissions. DE is only used in...
  • Page 152 Coordinator/Router/EndDevice, or active search for network joining (association) by Routers and End Devices will be limited to no more than 3 dBm on Channel 26 - the transmit power on other channels will be controlled by PL and PM configuration settings. © 2014 Digi International Inc.      152...
  • Page 153 Link Key. Set the 128-bit AES link key. This command is write only; KY cannot be read. Setting KY to 0 will cause the coordinator to transmit the network key in the clear to 128-bit value joining devices, and will cause joining devices to acquire the network key in the clear when joining. © 2014 Digi International Inc.      153...
  • Page 154 API Options. Configure options for API. Current options select the type of receive API 3 - enable ZDO frame to send out the Uart for received RF data packets. passthrough of ZDO requests to the serial port which are not supported by the stack, as well as Simple_Desc_req, Active_EP_req, and Match_Desc_req. © 2014 Digi International Inc.      154...
  • Page 155 Unused bits : 0 - 0xFFFF should be set to 0. Bit (IO pin): 0 (DIO0)4 (DIO4)8 (DIO8) 1 (DIO1) 5 (DIO5) 9 (DIO9) 2 (DIO2) 6 (DIO6) 10 (DIO10) 3 (DIO3) 7 (DIO7) 11 (DIO11) © 2014 Digi International Inc.      155...
  • Page 156 0 – Unmonitored digital input 1 - SPI data available indicator P9** DIO19 / SPI_Attn / PTI_DATA. Set/read function for DIO19. 6 – Packet trace interface data output. Must be set along with D1=6 to output traces for OTA sniffing. © 2014 Digi International Inc.      156...
  • Page 157 0, 0x0A - 0xFF (100 - for the LED when the module has joined a network. If LT=0, the default blink rate will be 2550 ms) used (500ms coordinator, 250ms router/end device). For all other LT values, LT is measured in 10ms. © 2014 Digi International Inc.      157...
  • Page 158 • ** indicates that the command is available on the SMT module, but not the TH module. Diagnostics Diagnostics Commands AT Name and Description Parameter Range Default Command Firmware Version. Read firmware version of the module as a 4-digit hex number. 0 - 0xFFFF [read-only] Factory-set © 2014 Digi International Inc.      158...
  • Page 159 Time Before Sleep Sets the time before sleep timer on an end device.The timer is reset 0x1388 (5 each time serial or RF data is received. Once the timer expires, an end device may enter 1 - 0xFFFE (x 1ms) seconds) low power operation. Applicable for cyclic sleep end devices only. © 2014 Digi International Inc.      159...
  • Page 160 Note: This command only has effect in API mode (sleeps immediately whether given as a 0x08 or 0x09 API frame), and no effect in AT command mode. AT command mode is exited only by the CN command or by timeout. © 2014 Digi International Inc.      160...
  • Page 161 (left blank), the command is terminated and an “ERROR” message is returned. In the case of an ERROR, Command Mode is not exited. The radius of the DN command is set by the BH command. Force Sample Forces a read of all enabled digital and analog input lines. © 2014 Digi International Inc.      161...

  • Page 162: 11. Xbee Zigbee Module Support

    Contact Digi to create a custom configuration. Design Considerations for Digi Drop-In Networking XBee RF modules contain a variety of features that allow for interoperability with Digi's full line of Drop-in Networking products. Interoperability with other "DIN" products can offer these advantages: •Add IP-connectivity to your network via Cellular, Ethernet or WiFi with a ConnectPort X Gateway...

  • Page 163: Programming Xbee Modules

    4, 10, and 29 (DIN, DTR, and RTS respectively) on the SMT, and pins 3, 9, 16 on the TH. The XCTU program can update firmware serially on the XBee. Contact Digi support for details. If an application requires custom firmware to update the XBee firmware serially, the following steps are required.

  • Page 164: Enabling Gpio 1 And 2

    (for example, an LED tied directly to the ASSOCIATE / DIO5 line). Any loading circuitry should be buffered to avoid conflicts (for example, connecting ASSOCIATE / DIO5 to the gate of a MOSFET which drives the LED). © 2014 Digi International Inc.      164...
  • Page 165 ® ® XBee /XBee‐PRO  ZB RF Modules  JTAG pin name Primary XBee pin Secondary XBee pin Secondary pin name JTCK JTDO ON / SLEEP / DIO9 JTDI ASSOCIATE / DIO5 JTMS DIO12 © 2014 Digi International Inc.      165...

  • Page 166: Appendix A: Agency Certifications

    (as per FCC section 2.1091). Modifications not expressly approved by Digi could void the user's authority to operate the equipment. IMPORTANT: OEMs must test final product to comply with unintentional radiators (FCC section 15.107 &...

  • Page 167: Fcc-Approved Antennas (2.4 Ghz)

    XBee ZB RF Modules have been tested and approved for use with all the antennas listed in the tables below. (Cable-loss IS required when using gain antennas as shown below.) The antennas in the tables below have been approved for use with this module. Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas.
  • Page 168 12.0 dBi Fixed 6.0 dB A24-Y15NF Yagi (15-element) 12.5 dBi Fixed 6.5 dB A24-Y16NF Yagi (16-element) 13.5 dBi Fixed 7.5 dB A24-Y16RM Yagi (16-element, RPSMA connector) 13.5 dBi Fixed 7.5 dB A24-Y18NF Yagi (18-element) 15.0 dBi Fixed 9.0 dB © 2014 Digi International Inc.      168...
  • Page 169 20 cm A24-HABSM Dipole (Articulated RPSMA) 2.1 dBi Fixed 20 cm 29000095 Dipole (Half-wave articulated RPSMA - 4.5”) 2.1 dBi Fixed/Moblie 20 cm A24-HABUF-P5I Dipole (Half-wave articulated bulkhead mount U.FL. w/ 5” pigtail) 2.1 dBi Fixed/Mobile 20 cm © 2014 Digi International Inc.      169...
  • Page 170 12.0 dBi Fixed 5.6 dB A24-Y15NF Yagi (15-element) 12.5 dBi Fixed 6.1 dB A24-Y16NF Yagi (16-element) 13.5 dBi Fixed 7.1 dB A24-Y16RM Yagi (16-element, RPSMA connector) 13.5 dBi Fixed 7.1 dB A24-Y18NF Yagi (18-element) 15.0 dBi Fixed 8.6 dB © 2014 Digi International Inc.      170...
  • Page 171 To ensure compliance, operations at closer than this distance are not recommended. The antenna used for this transmitter must not be co-located in conjunction with any other antenna or transmitter. The preceding statement must be included as a CAUTION statement in OEM product manuals in order to alert users of FCC RF Exposure compliance. © 2014 Digi International Inc.      171...

  • Page 172: Europe (Etsi)

    Files can be obtained by contacting Digi Support. Important Note: Digi does not list the entire set of standards that must be met for each country. Digi customers assume full responsibility for learning and meeting the required guidelines for each country in their distribution market.

  • Page 173: Antennas

    R&TTE Directive - Equipment requirements, placement on market: Available at www.ero.dk/. Antennas The following antennas have been tested and approved for use with the embedded XBee RF Module: - Dipole (2.1 dBi, Omni-directional, Articulated RPSMA, Digi part number A24-HABSM) - PCB Antenna (0.0 dBi) - Monopole Whip (1.5 dBi)

  • Page 174: Australia (Rcm/C-Tick)

    In order to have a RCM/C-Tick mark on an end product, a company must comply with a or b below. a. have a company presence in Australia. b. have a company/distributor/agent in Australia that will sponsor the importing of the end  product. Contact Digi for questions related to locating a contact in Australia. © 2014 Digi International Inc.      174...

  • Page 175: Appendix B:migrating From Xbee Through-Hole To Xbee Surface Mount Modules

    PWM1 / DIO11 [reserved] DTR / SLEEP_RQ / DIO8 SPI_ATTN / BOOTMODE / DIO19 SPI_CLK / DIO18 SPI_SSEL / DIO17 SPI_MOSI / DIO16 SPI_MISO / DIO15 [reserved] [reserved] [reserved] [reserved] [reserved] DIO4 CTS / DIO7 ON / SLEEP / DIO9 © 2014 Digi International Inc.      175...
  • Page 176 One of the important differences between the Surface Mount and the Through-hole modules is the way they mount to the PCB. Different mounting techniques are required. Digi International has designed a footprint which will allow either module to be attached to a PCB. The layout is shown below. All dimensions are in inches.
  • Page 177 Pin 1 of the Through-hole design is lined up with pad 1 of the SMT design, but the pins are actually offset by one pad (see Pin Mapping above). By using diagonal traces to connect the appropriate pins, the layout will work for both modules. Information on attaching the SMT module is included in Appendix C below. © 2014 Digi International Inc.      177...

  • Page 178: Appendix C:manufacturing Information

    Baking is required if conditions b) or c) are not met. e) Baking is required if the humidity indicator inside the bag indicates a RH of 10% more. f) If baking is required, bake modules in trays stacked no more than 10 high for 4-6 hours at 125◦C. © 2014 Digi International Inc.      178...
  • Page 179 RF test points on the bottom of the module (see below). Furthermore, these modules have a ground plane in the middle on the back side for shielding purposes, which can be affected by copper traces directly below the module. © 2014 Digi International Inc.      179...
  • Page 180 The module may be removed from the OEM PCB by the use of a hot air rework station, or hot plate. Care should be taken not to overheat the module. During rework, the module temperature may rise above its internal solder melting point and care should be taken not to dislodge internal components from their intended positions. © 2014 Digi International Inc.      180...

  • Page 181: Appendix D:warranty Information

    The foregoing sets forth the full extent of Digi International’s warranties regarding the Product. Repair or replace- ment at Digi International’s option is the exclusive remedy. THIS WARRANTY IS GIVEN IN LIEU OF ALL OTHER WAR- RANTIES, EXPRESS OR IMPLIED, AND DIGI SPECIFICALLY DISCLAIMS ALL WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

  • Page 182: Appendix E:definitions

    End devices can be battery-powered and offer low-power operation. -- Several end devices can operate in one PAN -- Can be a data packet source and destination  -- All messages are relayed through a coordinator or router -- Lower power modes © 2014 Digi International Inc.      182...
  • Page 183 The ZigBee stack provides a layer of network functionality on top of the 802.15.4 spec- ification. For example, the mesh and routing capabilities available to ZigBee solutions are absent in the 802.15.4 protocol. © 2014 Digi International Inc.      183...

This manual is also suitable for:

Xbee-proXbee s2cXbeeS2cthPs2cthLegacy pro s2c

Table of Contents