Digi-Frame A4 Multi-Purpose Spécifications

Digi International Inc.11001 Bren Road EastMinnetonka, MN 55343 877 912-3444 or 952 912-3444 http://www.digi.com XBee®/XBee-PRO® SE (Smart Energy) RF

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 10SIF Header InterfaceThe XBee/XBee-PRO Smart Energy modules include a SIF programm

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 100Sending ZigBee Device Objects (ZDO) Commands with the APIZigBee Device Objects (

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 101Frame Fields Offset Example DescriptionAPI PacketStart Delimiter 00x7ELength MSB

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 102Sending ZigBee Cluster Library (ZCL) Commands with the APIThe ZigBee Cluster Lib

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 103Note: When sending ZCL commands, the AO command should be set to 1 to enable the

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 104In the above example, the Frame Control was constructed as follows:See the ZigBe

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 105Frame Fields Offset Example DescriptionAPI PacketStart Delimiter 00x7ELength MSB

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 106In the above example, the Frame Control field (offset 23) was constructed as fol

©2009DigiInternational,Inc. 1079.XBeeCommandReferenceTablesAddressingNodetypesthatsupportthecommand:C=Coordinator,R=Router,E=End

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 108NetworkingSecurity NetworkingCommandsAT CommandName and DescriptionNode Type1Pa

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 109RF Interfacing 1.Nodetypesthatsupportthecommand:C=Coordinator,R=Rout

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 11• Surface-mount single-row receptacles - Samtec P/N: SMM-110-02-SM-SDigi also re

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 110Serial Interfacing (I/O)1.Nodetypesthatsupportthecommand:C=Coordinator,

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 111Diagnostics1.Nodetypesthatsupportthecommand:C=Coordinator,R=Router,E

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 112Sleep CommandsExecution CommandsWhere most AT commands set or query register val

©2009DigiInternational,Inc. 11310.RFModuleSupportThis chapter provides customization information for the XBee/XBee-PRO SE modules. In add

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 114Invoke XBee BootloaderSee the "XBee Bootloader" section above for step

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 115Warning: If programming firmware through the SIF interface, be aware that upload

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 116x &= (0xFF0F);// Clear bits 4 - 7x |= 0x0070;// Set bits 4 - 7 to 0111 as sh

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 117XBee (non-PRO) Initialization: /* GPIO 1 and 2 are not used in the XBee (non-PR

©2009DigiInternational,Inc. 118AppendixA:DefinitionsDefinitionsTerms andDefinitionsZigBee Node TypesCoordinator A node that has the uniqu

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 119Joining The process of a node becoming part of a ZigBee PAN. A node becomes part

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 12EM250 Pin MappingsThe following table shows how the EM250 pins are used on the XB

©2009DigiInternational,Inc. 120AppendixB:AgencyCertificationsUnited States FCCThe XBee Module complies with Part 15 of the FCC rules and r

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 121FCC-Approved Antennas (2.4 GHz)The XBee and XBee-PRO Module can be installed uti

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 122antennasapprovedforusewiththeXBee‐PROModules* If using the RF module in

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 123Furthermore, the manufacturer must maintain a copy of the XBee user manual docum

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 124Antenna Type: Omni-DirectionalRF module was tested and approved with 15 dBi ante

©2009DigiInternational,Inc. 125AppendixC:Migrating fromXBeeZBtoXBeeSEThe following list includes the significant differences in XBee

©2009DigiInternational,Inc. 126AppendixD:SmartEnergyCertificatesAll devices that operate in a ZigBee smart energy deployment must have a

©2009DigiInternational,Inc. 127AppendixE:AdditionalInformation1-Year WarrantyXBee Modules from Digi International, Inc. (the "Product&

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 1320 can enable various join functions without having to send UART commands. Please

©2009DigiInternational,Inc. 142.ModuleOperationSerial CommunicationsThe XBee modules interface to a host device through a logic-level async

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 15Serial Receive BufferWhen serial data enters the RF module through the DIN Pin (p

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 16payload information instead of using command mode to modify addresses. The module

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 17TransmitModeSequence16-bit NetworkAddress DiscoveryData DiscardedSuccessfulTran

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 18When data is transmitted from one node to another, a network-level acknowledgemen

©2009DigiInternational,Inc. 193.XBeeZigBeeNetworksIntroduction to ZigBeeZigBee is an open global standard built on the IEEE 802.15.4 MAC/P

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 2© 2009 Digi International, Inc. All rights reservedNopartofthecontentsofthis

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 20• After joining, can assist in routing data• Cannot sleep--should be mains powere

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 21IDs) are operating on the same 16-bit PAN ID. If such a conflict is detected, the

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 22profile. In addition, the API can be used to send or receive messages on any clus

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 23Energy Service PortalThe Energy Service Portal (ESP) acts as a ZigBee Coordinator

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 24implement these clusters (except for the Key Establishment cluster) in the extern

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 25network, it can allow new devices to join the network. It can also route data pac

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 26XBee Smart Energy Coordinator StartupThe following commands control the coordinat

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 27the network should likewise be de-registered or removed from the trust center usi

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 280x0034 Cluster Id0x0000 Profile Id (ZDO)0x00 Broadcast radius - use maximum hops0

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 294. The Associate LED will start blinking once the coordinator has selected a chan

ContentsXBee®/XBee‐PRO®SERFModules©2009DigiInternaitonal,Inc. 3Overview 6Key Features 6Worldwide Acceptance

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 30Persistent DataOnce a router has joined a network, it retains the following infor

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 31The following commands control the router joining process.Once the router joins a

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 32These behaviors are configurable using the following commands:Key EstablishmentKe

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 33Scan SC channels for a valid networkValid network found?Join networkSuccessfully

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 34Permit JoiningThe permit joining attribute on the router is configurable with the

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 353. If SC or ID is changed from the default, apply changes (make SC and ID changes

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 36Parent Child RelationshipSince an end device may enter low power sleep modes and

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 37Orphan ScansWhen an end device comes up from a power cycle, it performs an orphan

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 38Parent ConnectivityThe XBee Smart Energy end device sends regular poll transmissi

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 395. If the Associate LED is not blinking, the AI command can be read to determine

ContentsXBee®/XBee‐PRO®SERFModules©2009DigiInternaitonal,Inc. 4Application Layer Addressing 43Data Transmiss

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 40The response will be the ZigBee Register Joining Device Status (0xA4) API frame w

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 41DiscoveryAfter a device has joined and been authenticated, typically service disc

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 42Simple Descriptor ExampleOne can obtain the simple descriptor for an endpoint on

©2009DigiInternational,Inc. 434.DataTransmission,Addressing,andRout‐ingAddressingAll ZigBee devices have two different addresses, a 64-b

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 44BroadcastDataTransmissionEach node that transmits the broadcast will also crea

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 45transmission check the 64-bit address in the payload and compare it to their own

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 46The API transmit frame can include up to 128 bytes of data, which will be broken

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 47Note – End devices do not make use of these routing protocols. Rather, an end dev

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 48AODV Mesh Routing ZigBee employs mesh routing to establish a route between the so

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 49 SampleRouteRequest(Broadcast)TransmissionWh ereR3isTryingtoDiscovera

ContentsXBee®/XBee‐PRO®SERFModules©2009DigiInternaitonal,Inc. 5AT Command - Queue Parameter Value 88Explicit

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 50the data, up to 2 times until an ACK is received. This ACK is called the ZigBee A

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 51

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 52Acquiring Source RoutesAcquiring source routes requires the remote device to send

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 53To send a source-routed packet to R3, the application must send a Create Source R

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 54Encrypted TransmissionsEncrypted transmissions are routed similar to non-encrypte

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 55Data Throughput*RR = router to router, RE = router to end device (non-sleeping),E

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 56Refer to the ZigBee specification for a detailed description of all ZigBee Device

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 570x00 - Required payload for LQI request command0xCE - Checksum (0xFF - SUM (all b

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 58The ZigBee stack includes some provisions for a device to detect if the destinati

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 5940.5 seconds.Transmission ExamplesExample 1: Send a unicast API data transmission

©2009DigiInternational,Inc. 61.OverviewThe XBee/XBee-PRO Smart Energy RF Modules are designed to support the implementation of Smart Energy

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 60Description:This transmission sends the string "TxData" as a broadcast

©2009DigiInternational,Inc. 615.SecurityZigBee supports various levels of security that can be configured depending on the needs of the appl

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 62Frame CounterThe network header of encrypted packets includes a 32-bit frame coun

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 63Since network encryption is performed at each hop, packet latency is slightly lon

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 64APS Layer Encryption and DecryptionPackets with APS layer encryption are encrypte

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 65that are not pre-configured with the link key. Sending the network key unencrypte

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 66is only decrypted by the destination device. The XBee must be configured with sec

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 67Example 2: Forming a network with security (obtaining keys during joining)1. Star

©2009DigiInternational,Inc. 686.ManagingEndDevicesZigBee end devices are intended to be battery-powered devices capable of sleeping for ex

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 69Since the end device children are not guaranteed to be awake at a given time, the

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 7Worldwide AcceptanceFCC Approval (USA) Refer to Appendix A for FCC Requirements. S

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 70Non-Parent Device OperationDevices in the ZigBee network treat data transmissions

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 71In the figure above, t1, t2, and t3 represent the following events:•T1 - Time whe

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 72DemonstrationofPinSleepParent and remote devices must be configured to buffer

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 73In the figure above, t1, t2, and t3 represent the following events:• T1 - Time wh

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 74Sleep PeriodThe sleep period is configured based on the SP, SN, and SO commands.

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 75a number of sleep periods have expired (SN sleep periods). This mechanism allows

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 76asserted (low). In cyclic sleep mode, the end device will only poll once before r

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 77RF Packet Buffering TimeoutWhen a router or coordinator receives an RF data packe

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 78devices in a network have more than one SP setting, SP on the routers and coordin

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 79ST = 0x7D0 (2 second wake time)SO = 0x06 (enable extended sleep and wake for ST t

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 8SpecificationsSpecificationsoftheXBee®/XBee‐PRO®SERFModuleSpecification XBe

©2009DigiInternational,Inc. 807.NetworkCommissioningandDiagnosticsNetwork commissioning is the process whereby devices in a mesh network

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 81Commissioning PushbuttonThe commissioning pushbutton definitions provide a variet

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 82once, and the device has not joined a network, the Associate pin blinks a numeric

©2009DigiInternational,Inc. 838.APIOperationAPI (Application Programming Interface) Operations are available for communicating with an ext

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 84Data bytes that need to be escaped:• 0x7E – Frame Delimiter•0x7D – Escape• 0x11 –

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 85ChecksumTo test data integrity, a checksum is calculated and verified on non-esca

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 86Source RoutingThe following image shows the API frame exchanges that take place a

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 87API FramesThe following sections illustrate the types of frames encountered while

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 88The above example illustrates an AT Command when setting an NJ value. AT Command

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 89The 64-bit destination address should be set to 0x000000000000FFFF for a broadcas

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 9Mechanical DrawingsMechanicaldrawingsoftheXBee®/XBee‐PRO®SERFModules(anten

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 90Example: Send a data transmission to the coordinator (64-bit address of 0x00s) us

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 91ZigBee Create Source RouteFrame Type: 0x21This frame creates a source route in th

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 92ZigBee Register Joining DeviceFrame Type: 0x24A KY command can be used to set the

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 93AT Command ResponseFrame Type: 0x88 In response to an AT Command message, the mod

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 94ZigBee Transmit StatusFrame Type: 0x8B When a TX Request is completed, the module

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 95ZigBee Explicit Rx IndicatorFrame Type:0x91 When the modem receives a ZigBee RF p

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 96Route Record IndicatorFrame Type: 0xA1The route record indicator is received when

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 97ZigBee Device Authenticated IndicatorFrame Type: 0xA2This frame is sent out the U

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 98ZigBee Many-to-One Route Request IndicatorFrame Type: 0xA3This message is sent ou

XBee®/XBee‐PRO®SERFModules©2009DigiInternational,Inc. 99ZigBee Register Joining Device StatusFrame Type: 0xA4This frame is sent out the U