Digi XBee 868LP, User Manual

Page 1: ...XBee 868LP Radio Frequency RF Modules User Guide...

Page 2: ...ners 2018 Digi International Inc All rights reserved Disclaimers Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International...

Page 3: ...ns and service packages Contact us at 1 952 912 3444 or visit us at www digi com support Feedback To provide feedback on this document email your comments to techcomm digi com Include the document tit...

Page 4: ...IO specifications 17 Hardware specifications for the programmable variant 17 Hardware Mechanical drawings 20 Pin signals 20 Design notes 22 Power supply design 22 Board layout 23 Antenna performance 2...

Page 5: ...st 60 Port in use 61 XCTU cannot discover devices 61 XCTU cannot discover remote devices 62 XCTU cannot discover remote devices for a range test 62 XCTU installation error 63 Configure the XBee 868LP...

Page 6: ...ct messaging and polling 86 Indirect messaging 86 Polling 86 Sleeping routers 87 Sleep coordinator sleep modes in the DigiMesh network 87 Synchronization messages 87 Become a sleep coordinator 90 Sele...

Page 7: ...ONSE 0x85 117 FIRMWARE_VERIFY _AND_INSTALL_RESPONSE 0x86 117 Over the air firmware updates 118 Distribute the new application 118 Verify the new application 119 Install the application 119 Networking...

Page 8: ...l Number Low 135 DH Destination Address High 136 DL Destination Address Low 136 TO Transmit Options 136 NI Node Identifier 137 NT Node Discover Timeout 137 NO Node Discovery Options 137 CI Cluster ID...

Page 9: ...ommands 155 AV Analog Voltage Reference 155 IC DIO Change Detection 156 IF Sleep Sample Rate 157 IR I O Sample Rate 157 TP Temperature 157 IS Force Sample 157 V Voltage Supply Monitoring 158 Sleep com...

Page 10: ...rame 0x88 183 Modem Status frame 0x8A 185 Transmit Status frame 0x8B 186 Route Information Packet frame 0x8D 188 Aggregate Addressing Update frame 0x8E 191 Receive Packet frame 0x90 193 Explicit Rx In...

Page 11: ...ee 868LP RF Module consists of firmware loaded onto Digi XBee S8 hardware You can build networks up to 128 nodes using the XBee modules For larger networks up to 1000 nodes Digi offers RF Optimization...

Page 12: ...nergy Micro EFM 32G230F128 microcontroller an Analog Devices ADF7023 radio transceiver and in the Programmable version a NXP MC9S08QE32 microcontroller European acceptance The Digi XBee 868LP is manuf...

Page 13: ...ications 14 Power requirements 15 General specifications 15 Networking and security 16 Regulatory conformity summary 16 Serial communication specifications 16 GPIO specifications 17 Hardware specifica...

Page 14: ...ded antenna Outdoor RF line of sight range Up to 5 2 miles 8 4 km with a 2 1 dBi antenna up to 0 4 miles 64 km with a PCB embedded antenna Transmit power output Up to 14 dBm 25 mW EIRP with 2 1 dBi an...

Page 15: ...urrent high data rate 27 mA 22 mA typical Idle receive current low data rate 26 mA 24 mA typical Sleep current 1 7 A General specifications The following table describes the general specifications for...

Page 16: ...ses Encryption 128 bit Advanced Encryption Standard AES Note For more information about the number of user selectable channels see OEM labeling requirements for countries in the European Community Reg...

Page 17: ...vides the electrical specifications for the GPIO pads GPIO electrical specification Value Low Schmitt switching threshold 0 3 x VDD High Schmitt switching threshold 0 7 x VDD Input pull up resistor va...

Page 18: ...sor specification Add to RX TX and sleep currents specifications depending on mode of operation Runtime current for 32 k running at 20 MHz 14 mA Runtime current for 32 k running at 1 MHz 1 mA Sleep cu...

Page 19: ...Hardware Mechanical drawings 20 Pin signals 20 Design notes 22 Module operation for the programmable variant 28 Programmable XBee SDK 29 XBee 868LP RF Modules User Guide 19...

Page 20: ...izontal line above the signal name indicates low asserted signals Pin Name Direction Default state Description 1 GND Ground 2 VDD Power supply 3 DIO13 DOUT Both Output GPIO UART Data Out 4 DIO14 DIN C...

Page 21: ...round 14 DIO18 SPI_CLK Input Input GPIO Serial Peripheral Interface Clock 15 DIO17 SPI_SSEL Input Input GPIO Serial Peripheral Interface not Select 16 DIO16 SPI_MOSI Input Input GPIO Serial Peripheral...

Page 22: ...ied with respect to the device See Design notes for details on pin connections These pins are not available for customer use Design notes The XBee modules do not require any external circuitry or spec...

Page 23: ...ition the antennas away from metal objects whenever possible Metal objects between the transmitter and receiver can block the radiation path or reduce the transmission distance Objects that are often...

Page 24: ...mation see Commissioning pushbutton and associate LED The source and sink capabilities are limited to 6 mA on all I O pads Only the programmable versions of these devices use the VREF pad pad 27 For c...

Page 25: ...the center of a ground plane Design notes for RF pad devices The RF pad is a soldered antenna connection The RF signal travels from pin 33 on the device to the antenna through an RF trace transmissio...

Page 26: ...ve a controlled thickness dielectric material in between n The second layer has a ground plane which runs underneath the entire RF pad area This ground plane is a distance d the thickness of the diele...

Page 27: ...ack The width in this example is approximately 0 025 in for a 50 trace assuming d 0 014 in and that the dielectric has a relative permittivity of 4 4 This trace width is a good fit with the device foo...

Page 28: ...ransmitted and received All other lines are in parallel and can be controlled by either the internal microcontroller or the MC9SO8QE micro see the block diagram in Operation for details The internal m...

Page 29: ...use the Programmable XBee SDK To use the SDK you must also download CodeWarrior The download links are n CodeWarrior IDE http ftp1 digi com support sampleapplications 40003004_B exe n Programmable XBe...

Page 30: ...u how to set up a mesh network using the DigiMesh protocol send data between devices and adjust XBee 868LP RF Module settings Note For more information about DigiMesh protocol and features see DigiMes...

Page 31: ...your XBee RF module development kit verify that your kit has all of the components and that you meet the system requirements Verify kit contents The XBee 868LP RF Module development kit contains the...

Page 32: ...or recommended USB ports n Three available USB ports for the XBee XBee PRO DigiMesh 2 4 development kit n Two available USB ports for the XBee 868LP development kit Note Only one computer is required...

Page 33: ...AUTION Before you remove a device from a development board make sure the board is not powered by a USB cable or a battery Step 1 Download and install XCTU This section contains download and install in...

Page 34: ...again with your user in the system 4 Go to www digi com xctu 5 Click Download 6 Under Download XCTU click the Linux installer link 7 Once the download is complete run the executable file and follow th...

Page 35: ...e drivers are automatically installed You can also install device drivers manually 1 Download and install the appropriate USB drivers from the Digi Support Site 2 Choose your operating system 3 Downlo...

Page 36: ...e something like this in the Radio Modules section Configure the first two devices in Transparent mode To transmit data wirelessly between your XBee devices configure them to be in the same network Ti...

Page 37: ...appear in the Radio Modules area For more information about the parameters see the following table Parameter XBEE_A XBEE_B Effect ID 2015 2015 Defines the network that a device will attach to This mu...

Page 38: ...to add the remote device that has been discovered Send messages through XCTU Use the XCTU console to have the two devices send messages to each other 1 Switch both XBee 868LP RF Modules to the console...

Page 39: ...both XBee modules l XBee 868LP The CM Channel Mask and HP Preamble ID are the same for both XBee modules Step 3 Create a mesh network This section describes how to add a third XBee module to create a...

Page 40: ...network consisting of three XBee devices Set up a third XBee module to create a mesh network To create a mesh network move XBEE_B away from XBEE_A until communication is lost then add XBEE_C to relay...

Page 41: ...ssage does not loop back which means XBEE_B did not receive it and it is out of range of XBEE_A f If the message loops back move XBEE_B farther away until it no longer loops back 2 Add and configure a...

Page 42: ...E_B e Have XBEE_A send a message to XBEE_B In the XBEE_A console type Hello In the following illustration the message loops back XBEE_C relayed your message to XBEE_B and you successfully established...

Page 43: ...ion on API mode see Operate in API mode Configure a device in API mode 1 Select XBEE_A and click the Configuration working modes button 2 Add this configuration AP API Mode 1 3 Click the Write radio s...

Page 44: ...board 3 In XCTU rediscover XBEE_B 4 Switch XBEE_A and XBEE_B to console mode a Select XBEE_A and click Then click to open a serial connection b Select XBEE_B and click Then click to open a serial con...

Page 45: ...Frame generator dialog configure the following parameters Protocol DigiMesh Mode API 1 Frame type 0x10 Transmit Request 64 bit dest address MAC address of XBEE_B RF data Type Hello XBee_B in the ASCII...

Page 46: ...e your frame is selected 13 In the Send a single frame area click Send selected frame 14 In the Frames log area select Transmit Request and then Transmit Status to look at the Frame details for each F...

Page 47: ...dio module s persistent memory that provides the control program for the device Use XCTU to update the firmware 1 Click the Configuration working modes button 2 Add local and remote XBee modules to yo...

Page 48: ...ure remote devices in either API or Transparent mode These instructions show you how to configure the LT Associate LED Blink Time parameter on a remote device 1 Add two XBee devices to XCTU See Add de...

Page 49: ...blink times change the LT parameter back to 0 for XBEE_B Set up and perform a range test This section shows you how to set up two XBee modules to perform a range test which demonstrates the real world...

Page 50: ...lick 6 Configure the following parameters ID 2015 NI XBEE_B AP API disabled 0 7 Click the Write radio settings button After you write the radio settings for each device their names appear in the Radio...

Page 51: ...overy of remote devices starts When the discovery process finishes the other device XBEE_B appears in the Discovering remote devices dialog 3 Click Add selected devices 4 Select XBEE_B from the Discov...

Page 52: ...g a range test session In the following illustration the percentage of packets successfully sent is 69 and received is 64 The actual percentage of packets successfully sent or received may be higher 1...

Page 53: ...l impact on battery life Note If you have only two USB cables After you configure XBEE_B disconnect it from your computer and remove it from XCTU Then connect it to a power supply or laptop or portabl...

Page 54: ...E_B and configure the following sleep parameters SM 8 SO 0 allows the XBee module to take over the role of sleep coordinator if the preferred sleep coordinator fails SP 1E hexidecimal 30 decimal x 10...

Page 55: ...These instructions demonstrate the importance of observing flow control while XBees are sending and receiving data during synchronous sleep support Flow control is the process used by a device to inf...

Page 56: ...E_B type Hello XBee_A It is Friday How are you Since XBEE_B is a synchronized sleeping module it only transmits the part of the message that is typed while it is awake In the illustration below it was...

Page 57: ...w to configure XBee 868LP RF Modules for secure communication via encryption keys Note You can use encryption for devices that have been configured for either Transparent or API mode 1 Add two XBee mo...

Page 58: ...roadcast transmission A broadcast transmission transmits the same data to all nodes on the network These transmissions are propagated throughout the entire network so that all possible nodes receive t...

Page 59: ...control the route a data packet takes or when you need to know which node a data packet is from The device communicates UART data in packets also known as API frames This mode allows for structured co...

Page 60: ...ow on its development board No remote devices to select for a range test If there are no remote devices to select in the Radio Range Test dialog try one of the following resolutions Check cables The U...

Page 61: ...not display any serial ports try the following resolutions Check the configuration of your USB serial converter 1 On the Start menu click Computer System Properties Device Manager 2 Under Serial Bus c...

Page 62: ...nt board indicates if the XBee module is awake LED on or asleep LED off When an XBee module is sleeping XCTU cannot discover it so press the Commissioning button to wake it up for 30 seconds XCTU cann...

Page 63: ...the Device Selection area in the Radio Range Test dialog click the Discover remote devices button and XCTU will discover devices on the local device s network XCTU installation error An error is repo...

Page 64: ...On Windows systems a User Account Control dialog may appear when you install XCTU or try to run the XCTU program You must answer yes when prompted to allow the program to make changes to your computer...

Page 65: ...Configure the XBee 868LP RF Module Software libraries 66 XBee Network Assistant 66 XBee 868LP RF Modules User Guide 65...

Page 66: ...d to inspect and manage RF networks created by Digi XBee devices Features include n Join and inspect any nearby XBee network to get detailed information about all the nodes it contains n Update the co...

Page 67: ...omatic Frequency Agility 68 Single frequency mode band mode 69 Serial communications 69 Configuration considerations 73 Serial buffers 74 UART flow control 74 Force UART operation 75 Serial interface...

Page 68: ...posed by European standards LBT AFA requires that you use at least two frequencies for transmission This feature provides a level of fairness to the devices in a given area Before this device transmit...

Page 69: ...le requirement or 100 duty cycle n The PL setting must be set to 5 mW to comply with the single frequency mode requirements Serial communications RF Modules interface to a host device through a serial...

Page 70: ...ing table shows the signals that the SPI port uses on the device Signal Function SPI_MOSI Master Out Slave In Inputs serial data from the master SPI_MISO Master In Slave Out Outputs serial data to the...

Page 71: ...nals SPI_MISO SPI_MOSI SPI_CLK and SPI_SSEL Using only these four signals the master cannot know when the slave needs to send and the SPI slave cannot transmit unless enabled by the master For this re...

Page 72: ...pull up resistors When the SPI pins are not connected but the pins are configured for SPI operation the pull ups are required for proper UART operation Full duplex operation SPI on the XBee 868LP RF M...

Page 73: ...pose If the device is one of multiple slaves on the SPI then the device sleeps while the SPI master talks to the other slave but this is acceptable in most cases If you do not configure either pin as...

Page 74: ...iguration to ensure that at least one serial port is operational Serial receive buffer When serial data enters the device through the DIN pin or the MOSI pin it stores the data in the serial receive b...

Page 75: ...for all of the data bytes it discards the entire RF data packet The UART Data Present Indicator is a useful feature when using RTS flow control When enabled the DIO19 line asserts low asserted when UA...

Page 76: ...tends the level to which a host application can interact with the networking capabilities of the device When in API mode the device contains all data entering and leaving in frames that define operati...

Page 77: ...d receive frames can expose addressing fields including source and destination endpoints cluster ID and profile ID Advanced networking diagnostics API frames can provide indication of I O samples from...

Page 78: ...f operation under the following conditions n Transmit mode Serial data in the serial receive buffer is ready to be packetized n Sleep mode n Command Mode Command mode sequence is issued not available...

Page 79: ...e Data transmission and routing Receive mode This is the default mode for the XBee 868LP RF Module The device is in Receive mode when it is not transmitting data If a destination node receives a valid...

Page 80: ...he guard times and the timeout in the device s configuration settings For more information see CC Command Sequence Character CT Command Mode Timeout and GT Guard Times Troubleshooting Failure to enter...

Page 81: ...K message ATAP cr 1 cr Apply command changes Any changes you make to the configuration command registers using AT commands do not take effect until you apply the changes For example if you send the BD...

Page 82: ...power consumption when not in use The XBee 868LP RF Module supports both pin sleep Sleep mode entered on pin transition and cyclic sleep device sleeps for a fixed time Sleep modes allow the device to...

Page 83: ...ic sleep mode 85 Asynchronous cyclic sleep with pin wake up mode 85 Synchronous sleep support mode 85 Synchronous cyclic sleep mode 85 Wake timer 86 Indirect messaging and polling 86 Sleeping routers...

Page 84: ...l RF packet called a sync message to synchronize nodes n To make a device in the network a coordinator a node uses several resolution criteria through a process called nomination n The sleep coordinat...

Page 85: ...d expires or if a high to low transition occurs on the SLEEP_RQ pin Synchronous sleep support mode Set SM to 7 to enter synchronous sleep support mode A device in synchronous sleep support mode synchr...

Page 86: ...it is received over the serial port Instead the device holds onto the data until it is requested via a poll On receiving a poll the indirect messaging coordinator sends a queued data packet if availa...

Page 87: ...des that receive a sync message remain awake for the wake time and then sleep for the specified sleep period The sleep coordinator sends one sync message at the beginning of each cycle with the curren...

Page 88: ...al time A node that is not a sleep coordinator and has never been synchronized sends a message requesting sync information at the beginning of its wake cycle Synchronized nodes which receive one of th...

Page 89: ...Sleep modes Sleep coordinator sleep modes in the DigiMesh network XBee 868LP RF Modules User Guide 89...

Page 90: ...ion become weaknesses if you use it on a node that is not in the proper position or configuration You can also use the preferred sleep coordinator option when you set up a network for the first time W...

Page 91: ...make changes to the network s sleep and wake times If you change a node s SP or ST to values different from those that the network is using the node becomes the sleep coordinator The node begins sendi...

Page 92: ...ll 2 Calculate the Sync Message Propagation Time SMPT This is the maximum amount of time it takes for a sleep synchronization message to propagate to every node in the network You can estimate this nu...

Page 93: ...ning Pushbutton twice This causes the node to begin emitting sync messages 3 Verify that the first node is emitting sync messages by watching its associate LED A slow blink indicates that the node is...

Page 94: ...he risk of a node losing sync and to facilitate the re syncing of a node that does lose sync take the following precautions 1 Whenever possible avoid changing sleep parameters 2 Enable the missed sync...

Page 95: ...e sleep support node that is in range of the other subnet 5 Wait for the out of sync subnet to wake up and send a sync When the sleep support node receives this sync it rejects it and sends a sync to...

Page 96: ...giMesh network XBee 868LP RF Modules User Guide 96 Sleep status API messages When you use the SO command to enable this option a device that is in API operating mode outputs modem status frames immedi...

Page 97: ...configuration commands 98 Network commissioning and diagnostics 98 I O line monitoring 107 General Purpose Flash Memory 110 General Purpose Flash Memory commands 112 Over the air firmware updates 118...

Page 98: ...nd the API frame ID is non zero the remote sends a remote command response transmission back to the device that sent the remote command When a remote command response transmission is received a device...

Page 99: ...the DH DL of the device receiving the AG broadcast you can use the invalid address of 0xFFFE API enabled devices output an Aggregate Addressing Update frame 0x8E if they update their DH DL address All...

Page 100: ...d signal strength of the last hop If a transmission spans multiple hops the DB value provides no indication of the overall transmission path or the quality of the worst link it only indicates the qual...

Page 101: ...ssing information n Node identifier string see NI Node Identifier n Other relevant information You can use this command for generating a list of all module addresses in a network Neighbor polling Use...

Page 102: ...ce transmits any received serial characters to the remote device and returned to the sender API configuration AP 1 or AP 2 Send an Explicit Addressing Command API frame 0x11 using 0x12 as the cluster...

Page 103: ...that the link between device A SH SL 0x0013a20040521234 and device B SH SL 0x0013a2004052abcd is being tested by transmitting 1 000 40 byte packets Send the following API packet to the serial interfa...

Page 104: ...D to E D transmits an RI Packet to A through C and B Then A outputs this RI packet out its serial interface Route Information packets are not guaranteed to arrive in the same order as the unicast pack...

Page 105: ...D0 command to 1 enabled by default Button Presses Sleep configuration and sync status Action 1 Not configured for sleep Immediately sends a Node Identification broadcast transmission All devices that...

Page 106: ...ou want executee For example sending CB1 executes the actions associated with a single button press The node identification frame is similar to the node discovery response frame it contains the device...

Page 107: ...ng Pushbutton once the device transmits a broadcast Node Identification Indicator 0x95 frame at the beginning of the next wake cycle if the device is sleep compatible or immediately if the device is n...

Page 108: ...rs for each digital input Use the PD command to determine the direction of the internal pull up down resistor Field Name Description 1 Sample sets Number of sample sets in the packet Always set to 1 2...

Page 109: ...us list If you issue a command via an API frame the device returns an AT command response API frame with the I O data included in the command data portion of the packet Example Sample AT response 0x01...

Page 110: ...write to This memory provides a non volatile data storage area that an application uses for many purposes Some common uses of this data storage include n Storing logged sensor data n Buffering firmwar...

Page 111: ...outputs a GPM response as an explicit API RX indicator frame assuming it has API mode enabled The format of the response is similar to the request packet Byte offset in payload Number of bytes Field n...

Page 112: ...UM This field is unused for this command Set to 0 GPM_START_INDEX This field is unused for this command Set to 0 GPM_NUM_BYTES This field is unused for this command Set to 0 GPM_DATA No data bytes sho...

Page 113: ...GPM_START_INDEX is unused set to 0 GPM_NUM_BYTES Setting GPM_NUM_BYTES to 0 has a special meaning It indicates that every flash block in the GPM should be erased not just the one specified with GPM_B...

Page 114: ...the GPM block that should be written GPM_START_INDEX Set to the byte index within the GPM block where the given data should be written GPM_NUM_BYTES Set to the number of bytes specified in the GPM_DAT...

Page 115: ...se the READ command to read the specified number of bytes from the GPM location specified Data can be queried from only one GPM block per command Field name Command specific description GPM_CMD_ID Sho...

Page 116: ...itten with incrementing data the following API packets would be output the source node s serial interface 7E 0007 8B 01 FFFE 00 00 00 76 7E 0029 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 84 00 0016...

Page 117: ...the source endpoint specified in the requesting frame only if the GPM memory does not contain a valid image If the image is valid the device resets and begins using the new firmware Field name Comman...

Page 118: ...pplication The first phase of performing an over the air update on a device is transferring the new firmware file to the target node Load the new firmware image in the target node s GPM prior to insta...

Page 119: ...can issue a FIRMWARE_ VERIFY_AND_INSTALL command Once the target receives the command it verifies the ebin file loaded in the GPM If it is valid then the device installs the new firmware This install...

Page 120: ...ethods available on the XBee 868LP RF Modules building from the simplest to the most complex Directed Broadcast Repeater mode 121 Point to Point Multipoint mode 121 DigiMesh networking 121 Networking...

Page 121: ...ble to establish a permanent circuit One example might be a telephone in the lobby of a public building that is programmed to ring only the number of a telephone dispatcher Nailing down a switched con...

Page 122: ...ks its ability to communicate the rest of the nodes can still communicate with each other either directly or through intermediate nodes Note Mesh networks use more bandwidth for administration and the...

Page 123: ...ow that the data packet arrived at the receiver If the transmitting device does not receive an acknowledgment then it re sends the packet It sends the packet a finite number of times before the system...

Page 124: ...ry is a process that occurs when 1 The source node does not have a route to the requested destination 2 A route fails This happens when the source node uses up its network retries without receiving an...

Page 125: ...operating mode receives a Transmit Request 0x10 0x11 frame or a device in Transparent operating mode meets the packetization requirements RO RB the time required to route the data to its destination...

Page 126: ...estimate the timeout in the following manner knownRouteUnicastTime 2 NH MR unicastOneHopTime Transmit a unicast with an unknown route If the transmitting device does not know the route to the destina...

Page 127: ...sing discovery configuration commands 139 Diagnostic addressing commands 141 Security commands 141 Serial interfacing commands 142 I O settings commands 144 I O sampling commands 155 Sleep commands 15...

Page 128: ...rms a reset 100 ms later If you issue FR while the device is in Command Mode the reset effectively exits Command mode Parameter range N A Default N A RE Restore Defaults Restore device parameters to f...

Page 129: ...alues for CM for example 0x0000FF00 and 0x000000FF then communication is possible because both devices still listen on all possible channels while limiting the transmission channels to those specified...

Page 130: ...e values include the gain of a 2 dBi antenna The conducted power is 2 dBi less Parameter range These parameters equate to the following settings for the XBee 868LP RF Module Setting Power level 0 2 mW...

Page 131: ...ts every byte of every packet including MAC PHY headers and trailers The purpose of this count is to estimate battery life by tracking time spent performing transmissions This number rolls over to 0 f...

Page 132: ...reset the counter to any 16 bit unsigned value append a hexadecimal parameter to the command Parameter range 0 0xFFFF Default 0 EA MAC ACK Timeouts This count increments whenever a MAC ACK timeout occ...

Page 133: ...can change this value Parameter range read only Default 0xCF 0x267 8 MAC Broadcast One Hop Time The MAC broadcast one hop time timeout in milliseconds If you change MAC parameters it can change this v...

Page 134: ...nator Note Bit 0 and Bit 2 cannot be set at the same time Parameter range 0 6 Default 0 BH Broadcast Hops The number of hops for broadcast data transmissions Set the value to 0 for the maximum number...

Page 135: ...rameter to 0 it disables network ACKs Initially the device can find routes but a route will never be repaired if it fails Parameter range 0 7 Default 1 Addressing commands The following AT commands ar...

Page 136: ...ures the transmit options for Transparent mode The device s transmit options The device uses these options for all transmissions You can override these options using the TxOptions field in the API TxR...

Page 137: ...n length A carriage return or a comma automatically ends the command Default One ASCII space character 0x20 NT Node Discover Timeout Sets the amount of time a base node waits for responses from other...

Page 138: ...Transparent data cluster ID Parameter range 0 0xFFFF Default 0x11 DE Destination Endpoint Sets or displays the application layer destination ID value The value is used as the destination endpoint for...

Page 139: ...NI Node identifier string to a physical address case sensitive The following events occur after DN discovers the destination node When DN is sent in Command mode 1 The device sets DL and DH to the ex...

Page 140: ...l character Parameter range N A Default N A FN Find Neighbors Discovers and reports all devices found within immediate 1 hop RF range FN reports the following information for each device it discovers...

Page 141: ...s are security commands EE Security Enable Enables or disables 128 bit Advanced Encryption Standard AES encryption Set this command parameter the same on all devices in a network Parameter range 0 1 P...

Page 142: ...s at 0x100 and above select the actual baud rate if the host supports it Parameter range Standard baud rates 0x0 0x8 Non standard baud rates 0x100 to 0x6ACFC0 Parameter Description 0x0 1200 b s 0x1 24...

Page 143: ...Default 0 RO Packetization Timeout Set or read the number of UART character times of inter character silence required before transmission begins when operating in Transparent mode Set RO to 0 to tran...

Page 144: ...and output data in API format without escape sequences 2 API Mode With Escapes The device is in API mode and inserts escaped sequences to allow for control characters The device passes XON XOFF Escap...

Page 145: ...the Commissioning Pushbutton once See The Commissioning Pushbutton See Commissioning pushbutton Parameter range 0 4 Default N A D0 AD0 DIO0 Configuration Sets or displays the DIO0 AD0 configuration pi...

Page 146: ...D2 DIO2 AD2 Sets or displays the DIO2 AD2 configuration pin 31 Parameter range 0 2 5 Parameter Description 0 Disabled 2 ADC 3 Digital input 4 Digital output low 5 Digital output high Default 0 D3 DIO...

Page 147: ...output low 5 Digital output high Default 0 D5 DIO5 ASSOCIATED_INDICATOR Sets or displays the DIO5 AD5 ASSOCIATED_INDICATOR configuration pin 28 Parameter range 0 1 3 5 Parameter Description 0 Disabled...

Page 148: ...er Description 0 Disabled 1 CTS flow control 3 Digital input 4 Digital output low 5 Digital output high 6 RS 485 Tx enable low Tx 0 V on transmit high when idle 7 RS 485 Tx enable high high Tx high on...

Page 149: ...D9 DIO9 ON_SLEEP Sets or displays the DIO9 ON_SLEEP configuration pin 26 Parameter range 0 1 3 5 Parameter Description 0 Disabled 1 ON SLEEP output 3 Digital input 4 Digital output low 5 Digital outp...

Page 150: ...isplays the DIO11 PWM1 configuration pin 8 Parameter range 0 5 Parameter Description 0 Disabled 1 32 768 kHz clock output 2 PWM1 output 3 Digital input 4 Digital output low 5 Digital output high Defau...

Page 151: ...0 Disabled 1 UART DOUT output Default 1 P4 DIO14 DIN Sets or displays the DIO14 DIN configuration pin 4 Parameter range 0 1 Parameter Description 0 Disabled 1 UART DIN input Default 1 P5 SPI_MISO Set...

Page 152: ...Disabled 1 SPI_MOSI 4 Digital output low 5 Digital output high Default 1 P7 DIO17 SPI_SSEL Sets or displays the DIO17 SPI_SSEL configuration pin 15 Parameter range 0 1 4 5 Parameter Description 0 Dis...

Page 153: ...own Direction The resistor pull direction bit field 1 pull up 0 pull down for corresponding I O lines that are set by the PR command Parameter range 0x0 0xFFFFF bit field Default 0x0 PR Pull up Down R...

Page 154: ...E pin 28 40 k 9 DIO9 On SLEEP pin 26 40 k 10 DIO12 pin 5 40 k 11 DIO10 PWM0 RSSI pin 7 40 k 12 DIO11 PWM1 pin 8 40 k 13 DIO7 CTS pin 25 40 k 14 DOUT pin 3 40 k 15 DIO15 SPI_MISO pin 17 40 k 16 DIO16 S...

Page 155: ...joined the network If LT 0 the device uses the default blink rate 500 ms for a sleep coordinator 250 ms for all other nodes For all other LT values the firmware measures LT in 10 ms increments Paramet...

Page 156: ...individual pin configuration commands D0 D9 P0 P2 If you enable a pin as a digital I O you can use the IC command to force an immediate I O sample transmission when the DIO state changes IC is a bitma...

Page 157: ...d digital I O and analog inputs at a specified interval Samples are sent to the address specified by the DH and DL commands To enable periodic sampling set IR to a non zero value and enable the analog...

Page 158: ...by the SLEEP_ REQUEST line 4 Asynchronous Cyclic Sleep In this mode the device periodically sleeps and wakes based on the SP and ST commands 5 Asynchronous cyclic sleep with pin wake up In this mode...

Page 159: ...sleep periods value This command controls the number of sleep periods that must elapse between assertions of the ON_SLEEP line during the wake time of Asynchronous Cyclic Sleep During cycles when ON_...

Page 160: ...r specifies a time in milliseconds that the device delays after waking from sleep before sending data out the UART or transmitting an I O sample If the device receives serial characters the WH timer s...

Page 161: ...ent mode All other bits Reserved Ignore all non documented bits Parameter range read only Default 0x40 OS Operating Sleep Time Reads the current network sleep time that the device is synchronized to i...

Page 162: ...ets or displays the character the device uses between guard times of the Command mode sequence The Command mode sequence causes the device to enter Command mode from Idle mode Note We recommend using...

Page 163: ...and mode Parameter range 0x2 0x95C x 1 ms Default 0x3E8 one second Firmware commands The following AT commands are firmware commands VL Version Long Shows detailed version information including the ap...

Page 164: ...Restore Defaults will not restore defaults The only way to get DD back to default values is to explicitly set it to defaults Parameter range 0 0xFFFFFFFF Default 0xC0000 NP Maximum Packet Payload Byte...

Page 165: ...Operate in API mode API mode overview 166 Frame data 171 XBee 868LP RF Modules User Guide 165...

Page 166: ...re a device to one of these modes set the following AP parameter values n AP 1 API operation n AP 2 API operation with escaped characters only possible on UART The API data frame structure differs dep...

Page 167: ...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 f...

Page 168: ...ate and verify checksums To calculate the checksum of an API frame 1 Add all bytes of the packet except the start delimiter 0x7E and the length the second and third bytes 2 Keep only the lowest 8 bits...

Page 169: ...correct checksum the XBee 868LP RF Module will consider the packet invalid and will ignore the data To verify the check sum of an API packet add all bytes including the checksum do not include the del...

Page 170: ...e does not receive the remote command Device Registration The following image shows the API frame exchanges that take place at the serial interface when registering a joining device to a trust center...

Page 171: ...on the purpose of the API frame Start delimiter Length Frame data Checksum Frame type Data 1 2 3 4 5 6 7 8 9 n n 1 0x7E MSB LSB API frame type Data Single byte n Frame type is the API frame type ident...

Page 172: ...s of the frame For details on frame structure see API frame format Frame data fields Offset Description Frame type 3 0x08 AT command 5 6 Command name two ASCII characters that identify the AT command...

Page 173: ...fies the data frame for the host to correlate with a subsequent ACK If set to 0 the device does not send a response AT command 5 6 Command name two ASCII characters that identify the AT command Parame...

Page 174: ...Operate in API mode Frame data XBee 868LP RF Modules User Guide 174 Frame data fields AT command 5 0x42 B 6 0x44 D Parameter value BD7 115200 baud 0x07 Checksum 8 0x68...

Page 175: ...iption Frame type 3 0x10 Frame ID 4 Identifies the data frame for the host to correlate with a subsequent ACK If set to 0 the device does not send a response 64 bit destination address 5 12 MSB first...

Page 176: ...e on the 10k product Example The example shows how to send a transmission to a device if you disable escaping AP 1 with destination address 0x0013A200 40014011 and payload TxData0A Frame data fields O...

Page 177: ...1 23 0x30 24 0x41 Checksum 25 0x13 If you enable escaping AP 2 the frame should look like 0x7E 0x00 0x16 0x10 0x01 0x00 0x7D 0x33 0xA2 0x00 0x40 0x0A 0x01 0x27 0xFF 0xFE 0x00 0x00 0x54 0x78 0x44 0x61...

Page 178: ...Status frame 0x8B indicates the discovered 16 bit address n Set the reserved field to 0xFFFE You can set the broadcast radius from 0 up to NH to 0xFF If the broadcast radius exceeds the value of NH t...

Page 179: ...Repeater mode directed broadcast b 11 DigiMesh not available on 10k product All other bits must be set to 0 Data payload 23 n Example The following example sends a data transmission to a device with n...

Page 180: ...s Offset Example Reserved MSB 13 0xFF LSB 14 0xFE Source endpoint 15 0xA0 Destination endpoint 16 0xA1 Cluster ID 17 0x15 18 0x54 Profile ID 19 0xC1 20 0x05 Broadcast radius 21 0x00 Transmit options 2...

Page 181: ...5 12 MSB first LSB last Set to the 64 bit address of the destination device Broadcast 0x000000000000FFFF Reserved 13 14 Set to 0xFFFE Remote command options 15 0x02 Apply changes on remote If you do...

Page 182: ...Length MSB 1 0x00 LSB 2 0x10 Frame type 3 0x17 Frame ID 4 0x01 64 bit destination address MSB 5 0x00 6 0x13 7 0xA2 8 0x00 9 0x40 10 0x40 11 0x11 LSB 12 0x22 Reserved 13 0xFF 14 0xFE Remote command opt...

Page 183: ...a frame being reported If Frame ID 0 in Command mode the device does not give an AT Command Response AT command 5 6 Command name two ASCII characters that identify the command Command status 7 0 OK 1...

Page 184: ...er Guide 184 Frame data fields Offset Example Length MSB 1 0x00 LSB 2 0x05 Frame type 3 0x88 Frame ID 4 0x01 AT command 5 0x42 B 6 0x44 D Command status 7 0x00 Command data No command data implies the...

Page 185: ...ts of the frame For details on frame structure see API frame format Frame data fields Offset Description Frame type 3 0x8A Status 4 0x00 Hardware reset 0x01 Watchdog timer reset 0x0B Network woke up 0...

Page 186: ...rame type 3 0x8B Frame ID 4 Identifies the serial interface data frame being reported If Frame ID 0 in the associated request frame no response frame is delivered Reserved 5 6 Set to 0xFFFE Transmit r...

Page 187: ...68LP RF Modules User Guide 187 Frame Fields Offset Example Length MSB 1 0x00 LSB 2 0x07 Frame type 3 0x8B Frame ID 4 0x47 Reserved 5 0xFF 6 0xFE Transmit retry count 7 0x00 Delivery status 8 0x00 Disc...

Page 188: ...umber of MAC ACK timeouts that occur TX blocked count 11 The number of times the transmission was blocked due to reception in progress Reserved 12 Reserved set to 0s Destination address 13 20 MSB firs...

Page 189: ...2BBBB to another device serial number 0x0013A200 4052CCCC Frame data fields Offset Example Start delimiter 0 0x7E Length MSB 1 0x00 LSB 2 0x2A Frame type 3 0x8D Source event 4 0x12 Length 5 0X2B Times...

Page 190: ...Example Source address MSB 21 0x00 22 0x13 23 0xA2 24 0x00 25 0x40 26 0x52 27 0xDD LSB 28 0xDD Responder address MSB 29 0x00 30 0x13 31 0xA2 32 0x00 33 0x40 34 0x52 35 0xBB LSB 36 0xBB Receiver addre...

Page 191: ...frame format Frame data fields Offset Description Frame type 3 0x8E Format ID 4 Byte reserved to indicate the format of additional packet information which may be added in future firmware revisions I...

Page 192: ...868LP RF Modules User Guide 192 Frame data fields Offset Example New address MSB 5 0x00 6 0x13 7 0xA2 8 0x00 9 0x40 10 0x52 11 0xBB LSB 12 0xBB Old address 13 0x00 14 0x13 15 0xA2 16 0x00 17 0x40 18 0...

Page 193: ...ress MSB first LSB last Reserved 12 13 Reserved Receive options 14 Bit field 0x00 Packet acknowledged 0x01 Packet was a broadcast packet 0x06 0x07 b 01 Point Multipoint b 10 Repeater mode directed bro...

Page 194: ...Guide 194 Frame data fields Offset Example 64 bit source address MSB 4 0x00 5 0x13 6 0xA2 7 0x00 8 0x40 9 0x52 10 0x2B LSB 11 0xAA Reserved 12 0xFF 13 0xFE Receive options 14 0x01 Received data 15 0x5...

Page 195: ...see API frame format Frame data fields Offset Description Frame type 3 0x91 64 bit source address 4 11 MSB first LSB last The sender s 64 bit address Reserved 12 13 Reserved Source endpoint 14 Endpoi...

Page 196: ...ds the following frame out its serial interface Frame data fields Offset Example Start delimiter 0 0x7E Length MSB 1 0x00 LSB 2 0x18 Frame type 3 0x91 64 bit source address MSB 4 0x00 5 0x13 6 0xA2 7...

Page 197: ...ender s 64 bit address Reserved 12 13 Reserved Receive options 14 Bit field 0x01 Packet acknowledged 0x02 Packet is a broadcast packet Ignore all other bits Number of samples 15 The number of sample s...

Page 198: ...er of 0x0013A20040522BAA The configuration of the transmitting device takes a digital sample of a number of digital I O lines and an analog sample of AD1 It reads the digital lines to be 0x0014 and th...

Page 199: ...Operate in API mode Frame data XBee 868LP RF Modules User Guide 199 Frame fields Offset Example Digital samples if included 19 0x00 20 0x14 Analog sample 21 0x02 22 0x25 Checksum 23 0xF5...

Page 200: ...0 fffe 0101 c105 101e 000c 0000 2e33 Format The following table provides the contents of the frame For details on frame structure see API frame format Frame data fields Offset Description Frame type 3...

Page 201: ...33 34 Set to the Digi Manufacturer ID Digi DD value optional 35 38 Reports the DD value of the responding device Use the NO command to enable this field RSSI optional 39 Received signal strength indic...

Page 202: ...64 bit remote address MSB 17 0x00 18 0x13 19 0xA2 20 0x00 21 0x40 22 0x74 23 0x02 LSB 24 0xAC NI string 25 0x20 26 0x00 Reserved 27 0xFF 28 0xFE Device type 29 0x01 Source event 30 0x01 Digi Profile...

Page 203: ...sed in to the request If Frame ID 0 in the associated request frame the device does not deliver a response frame 64 bit source remote address 5 12 The address of the remote device returning this respo...

Page 204: ...e Length MSB 1 0x00 LSB 2 0x13 Frame type 3 0x97 Frame ID 4 0x55 64 bit source remote address MSB 5 0x00 6 0x13 7 0xA2 8 0x00 9 0x40 10 0x52 11 0x2B LSB 12 0xAA Reserved 13 0xFF 14 0xFE AT commands 15...

Page 205: ...h other and offer the same basic feature set The surface mount form factor has more I O pins Because the XBee device was originally offered in only the through hole form factor we offer this section t...

Page 206: ...es of the through hole modules and offer the increased feature set SMT Pin Name TH Pin 1 GND 2 VDD 1 3 DOUT DIO13 2 4 DIN CONFIG DIO14 3 5 DIO12 4 6 RESET 5 7 RSSI PWM DIO10 6 8 PWM1 DIO11 7 9 reserve...

Page 207: ...19 33 AD0 DIO0 20 34 reserved 35 GND 36 RF 37 reserved Mounting One important difference between the surface mount and the through hole devices is how they mount to the PCB Different mounting techniqu...

Page 208: ...n and the semi oval pads are for the surface mount design Pin 1 of the through hole design lines up with pad 1 of the surface mount design but the pins are actually offset by one pad see Pin mapping B...

Page 209: ...lated pads to allow for easy solder attaching and inspection The pads are all located on the edge of the device so there are no hidden solder joints on these devices Recommended solder reflow cycle 21...

Page 210: ...ws during this cycle and must not be reflowed upside down Be careful not to jar the device while the solder is molten as parts inside the device can be removed from their required locations Hand solde...

Page 211: ...commend that the copper layer directly below the module be left open to avoid unintended contacts Copper or vias must not interfere with the three exposed RF test points on the bottom of the module se...

Page 212: ...between the device and the host PCB This can lead to unintended connections between pads n The residual moisture and flux residue under the device are not easily seen during an inspection process Not...

Page 213: ...ework though the warranty is still voided The device may be removed from the OEM PCB by the use of a hot air rework station or hot plate Be careful not to overheat the device During rework the device...

Page 214: ...Regulatory information Europe 215 Antennas 217 XBee 868LP RF Modules User Guide 214...

Page 215: ...the RE Directive Radio Equipment Directive Furthermore the manufacturer must maintain a copy of the XBee user manual documentation and ensure the final product does not exceed the specified power rat...

Page 216: ...must be affixed to a visible location on the OEM product The following figure shows CE labeling requirements The CE mark shall consist of the initials CE taking the following form n If the CE marking...

Page 217: ...Declarations of conformity Digi has issued Declarations of Conformity for the XBee RF Modules concerning emissions EMC and safety For more information see www digi com resources certifications Antenn...