Digi Digi XBee SX User Manual Download

Page: 131 / 206

Operate in API mode

API frames

XBee®/XBee-PRO SX RF Module User Guide

131

Modem Status frame - 0x8A

Description

Devices send the status messages in this frame in response to specific conditions.

Format

The following table provides the contents of the frame. For details on frame structure, see

API frame

specifications

Frame data fields

Offset

Description

Frame type

0x8A

Status

0x00 = Hardware reset
0x01 = Watchdog timer reset
0x0B = Network woke up
0x0C = Network went to sleep

Example

When a device powers up, it returns the following API frame.

Frame data fields

Offset

Example

Start delimiter

0x7E

Length

MSB 1

0x00

LSB 2

0x02

Frame type

0x8A

Status

0x00

Checksum

0x75

Summary of Contents for Digi XBee SX

Page 1: ...XBee XBee PRO SX Radio Frequency RF Module User Guide...

Page 2: ...ation in this document is subject to change without notice and does not represent a commitment on the part of Digi International Digi provides this document as is without warranty of any kind expresse...

Page 3: ...ing started with the XBee XBee PRO SX RF Module Development Kit XBee SX Development Board 24 Connect XBee PRO SX development boards to a PC 25 Connect the XBIB U SS development board to a PC 26 Config...

Page 4: ...inator 44 Preferred sleep coordinator option 44 Resolution criteria and selection option 44 Commissioning Pushbutton option 45 Auto early wake up sleep option 46 Select sleep parameters 46 Start a sle...

Page 5: ...68 ID Network ID 68 MT Broadcast Multi Transmits 68 BR RF Data Rate 68 PL TX Power Level 69 RR Unicast Mac Retries 70 Diagnostic commands MAC statistics and timeouts 70 BC Bytes Transmitted 70 DB Las...

Page 6: ...AD0 84 D1 DIO1 AD1 85 D2 DIO2 AD2 85 D3 DIO3 AD3 86 D4 DIO4 86 D5 DIO5 ASSOCIATED_INDICATOR 87 D6 DIO6 RTS 87 D7 DIO7 CTS 88 D8 DIO8 SLEEP_REQUEST 88 D9 DIO9 ON_SLEEP 89 P0 DIO10 RSSI PWM0 Configurat...

Page 7: ...gnostic sleep status timing commands 106 SS Sleep Status 106 OS Operating Sleep Time 107 OW Operating Wake Time 107 MS Missed Sync Messages 107 SQ Missed Sleep Sync Count 107 Command mode options 107...

Page 8: ...dentification Indicator frame 0x95 148 Remote Command Response frame 0x97 151 Work with networked devices Network commissioning and diagnostics 154 Local configuration 154 Remote configuration 154 Sen...

Page 9: ...e 179 Verify the new application 180 Install the application 180 Important considerations 180 Regulatory information FCC United States 182 OEM labeling requirements 182 FCC notices 182 FCC antenna cer...

Page 10: ...XBee XBee PRO SX RF Module User Guide 10 RF pad version 203 Recommended solder reflow cycle 204 Flux and cleaning 205 Rework 205...

Page 11: ...rmance in low power modes The module s frequency hopping technology offers advanced interference immunity affording long range data throughput even in challenging RF environments The XBee XBee PRO SX...

Page 12: ...rdware This manual supports the following firmware n 0x900X USA and Canada XBee XBee PRO SX n 0x920x Australia XBee XBee PRO SX n 0x930X Brazil XBee XBee PRO SX n 0x960X New Zealand XBee SX only Note...

Page 13: ...ifications Regulatory conformity summary 14 Power requirements 14 Networking specifications 14 Performance specifications 15 General specifications 16 GPIO specifications 17 XBee XBee PRO SX RF Module...

Page 14: ...uirements for the XBee XBee PRO SX RF Module Specification Condition XBee SX value XBee PRO SX value Supply voltage range 2 4 to 3 6 VDC 2 6 to 3 6 VDC Typical supply voltage 3 3 V Receive current VCC...

Page 15: ...ate BR 2 it is capped at 7 5 dBm Maximum data throughput High data rate 120 kb s Channels 10 hopping sequences share 50 frequencies Available channel frequencies Low middle data rate 1012 High data ra...

Page 16: ...rate 1000 kHz 45 dB Receiver RF selectivity Below 900 MHz and above 930 MHz 50 dB UART data rate software selectable 1200 921600 baud SPI clock rate Up to 6 Mb s General specifications The following t...

Page 17: ...following table provides the electrical specifications for the GPIO pads GPIO electrical specification Value Voltage supply 2 4 3 6 V Low Schmitt switching threshold 0 3 VCC High Schmitt switching th...

Page 18: ...Hardware Mechanical drawings 19 Pin signals 20 XBee XBee PRO SX RF Module User Guide 18...

Page 19: ...es show the XBee XBee PRO SX RF Module mechanical drawings All dimensions are in centimeters The XBee XBee PRO SX RF Module differs from other surface mount XBee modules It has an additional ground pa...

Page 20: ...lowing table describes the pin signals Low asserted signals are distinguished with a horizontal line over the signal name Pin Name I O Default state Function 1 GND Ground 2 VCC I Power supply 3 DIO13...

Page 21: ...tion or UART Data Present indicator 13 GND Ground 14 DO18 SPI_CLK I O 1 Input GPO SPI clock 15 DO17 SPI_SSEL I O 2 Input GPO SPI not select 16 DO16 SPI_MOSI I O 3 Input GPO SPI Data In 17 DO15 SPI_MIS...

Page 22: ...equest to Send Flow Control 30 DIO3 AD3 I O Disabled GPIO Analog Input 31 DIO2 AD2 I O Disabled GPIO Analog Input 32 DIO1 AD1 I O Disabled GPIO Analog Input 33 DIO0 AD0 I O Input GPIO Analog Input Com...

Page 23: ...azil XK9X DMS 1 This section describes how to set up an XBee network and adjust the XBee XBee PRO SX RF Module settings XBee SX Development Board 24 Connect XBee PRO SX development boards to a PC 25 C...

Page 24: ...Number Item Description 1 RSSI LEDs LEDs display the fade margin present in an active wireless link No LEDs illuminated indicates either a weak or no signal All three LEDs illuminated indicates a str...

Page 25: ...pad XBee 11 XBee XBee PRO SX RF Modulefootprint Connect XBee PRO SX development boards to a PC 1 Connect both SX development boards to power supplies and plug the power supplies into an outlet The pow...

Page 26: ...to the XBee device and an antenna Configure the device using XCTU XBee Configuration and Test Utility XCTU is a multi platform program that enables users to interact with Digi radio frequency RF devi...

Page 27: ...to and receive from each other Wireless environments vary dramatically depending on many factors and the range test allows you to experiment with the devices in your own environment The range test in...

Page 28: ...S with the XBee SX installed to your computer Open XCTU and find the three XBee devices 2 Configure all three devices with the following parameters and write the settings Note that XBee A SENDER shoul...

Page 29: ...iguring SENDER to send a broadcast message every second You can use the XCTU console or any serial port terminal application This tutorial uses the XCTU console 1 Switch to the Consoles working mode u...

Page 30: ...dule User Guide 30 6 Move RECEIVER away from SENDER until the Data Out LED does not blink anymore meaning it has moved out of range 7 Place BRIDGE about halfway between SENDER and RECEIVER and plug it...

Page 31: ...Modes Transparent and API operating modes 32 Modes of operation 33 XBee XBee PRO SX RF Module User Guide 31...

Page 32: ...operation of the radio network or when you need to know which node a data packet is from The device communicates UART or SPI data in packets also known as API frames This mode allows for structured c...

Page 33: ...d API mode when a device n Sends RF data to multiple destinations n Sends remote configuration commands to manage devices in the network n Receives RF data packets from multiple devices and the applic...

Page 34: ...p and is incapable of sending or receiving data until it wakes up XBee devices support pin sleep where the device enters sleep mode upon pin transition and cyclic sleep where the device sleeps for a f...

Page 35: ...baud rate of the device By default the BR parameter 3 9600 b s There are two alternative ways to enter Command mode Both of these methods temporarily set the device s baud rate to 9600 and return an O...

Page 36: ...until you apply the changes To apply changes 1 Send the AC Apply Changes command or 2 Exit Command mode Exit Command mode 1 Send the CN Exit Command Mode command followed by a carriage return or 2 If...

Page 37: ...ep mode 40 The sleep timer 40 Indirect messaging and polling 40 Sleeping routers 41 Sleep coordinator sleep modes in the DigiMesh network 41 Synchronization messages 42 Become a sleep coordinator 44 S...

Page 38: ...ng the CE command This prevents the node from attempting to route data n Transmissions sent to an asynchronously sleeping device are not buffered and will be lost if the receiving device is not active...

Page 39: ...ce receives serial or RF data while awake it extends the time before it returns to sleep by the specific amount the ST command provides Otherwise it enters sleep mode immediately The ON_SLEEP line pin...

Page 40: ...s sleep network to operate in either synchronous sleep support mode or synchronous cyclic sleep mode asynchronous sleeping nodes are not compatible with synchronous sleeping nodes The sleep timer If t...

Page 41: ...nchronous sleeping device that device sends a poll shortly after waking from sleep After that first poll is sent the device sends polls in the normal manner described previously until it returns to sl...

Page 42: ...message and sends a corrective sync to the sleep coordinator Use the SO sleep options command to disable deployment mode This option is enabled by default A sleep coordinator that is not in deployment...

Page 43: ...Sleep modes Synchronization messages XBee XBee PRO SX RF Module User Guide 43...

Page 44: ...coordinator CAUTION Use the preferred sleep coordinator bit with caution The advantages of using the option become weaknesses if you use it on a node that is not in the proper position or configurati...

Page 45: ...ameters Any sleep compatible node in the network that does not have the non coordinator sleep option set can make changes to the network s sleep and wake times If you change a node s SP or ST to value...

Page 46: ...for small networks can improve battery life but take care to not make the values too small 2 Calculate the Sync Message Propagation Time SMPT This is the maximum amount of time it takes for a sleep s...

Page 47: ...slow blink indicates that the node is acting as a sleep coordinator 4 Power on nodes in range of the sleep coordinator or other nodes that have synchronized with the network If the synchronized node...

Page 48: ...h the new sleep settings it continues to operate on its old settings To minimize the risk of a node losing sync and to facilitate the re syncing of a node that does lose sync take the following precau...

Page 49: ...this cycle the node you select to change the sleep cycle parameters sends the new settings to the entire subnet it is in range of including the sleep support node that is in range of the other subnet...

Page 50: ...he MS command to query the number of cycles that elapsed since the device received a sync message Sleep status API messages When you use the SO command to enable this option a device that is in API op...

Page 51: ...Networking methods The MAC and PHY layers 52 64 bit addresses 52 Make a unicast transmission 53 Make a broadcast transmission 53 Delivery methods 53 XBee XBee PRO SX RF Module User Guide 51...

Page 52: ...le shows the AT commands related to the MAC PHY layers AT command Function CM The Channel Mask is a user defined list of channels that the device operates on For additional information see CM Channel...

Page 53: ...t delivery method that the device uses when in Transparent mode In API mode the TxOptions field of the API frame overrides the TO command if non zero The XBee XBee PRO SX RF Module supports three deli...

Page 54: ...epleted If a node has already seen a repeated broadcast it ignores the broadcast The NH parameter sets the maximum number of hops that a broadcast transmission is repeated The device always uses the N...

Page 55: ...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 t...

Page 56: ...selects the route with the best round trip route quality which it uses for the queued packet and for subsequent packets with the same destination address Transmission timeouts When a device in API op...

Page 57: ...tTime 2 NH MR unicastOneHopTime Transmit a unicast with an unknown route If the transmitting device does not know the route to the destination it begins by sending a route discovery If the route disco...

Page 58: ...ignals 59 Slave mode characteristics 60 Full duplex operation 61 Low power operation 61 Configuration considerations 62 SPI and API mode 62 SPI parameters 62 Serial port selection 62 UART flow control...

Page 59: ...ure the UART of both devices the microcontroller and the XBee XBee PRO SX RF Module with compatible settings for the baud rate parity start bits stop bits and data bits Each data byte consists of a st...

Page 60: ...slave When you configure the device for SPI operations this pin is an input This signal clocks data transfers on MOSI and MISO SPI_SSEL The SPI master outputs a clock on this pin and the rate must no...

Page 61: ...e data is valid in both directions for a period of time Not only must the master and the slave both be able to keep up with the full duplex operation but both sides must honor the protocol The followi...

Page 62: ...configuration only applies to the UART interface and is ignored while using the SPI SPI parameters Most host processors with SPI hardware allow you to set the bit order clock phase and polarity For c...

Page 63: ...ata UART flow control You can use the RTS and CTS pins to provide RTS and or CTS flow control CTS flow control provides an indication to the host to stop sending serial data to the device RTS flow con...

Page 64: ...ing commands 77 Addressing discovery configuration commands 78 Security commands 80 Serial interfacing commands 81 I O settings commands 84 I O sampling commands 96 I O line passing commands 98 Sleep...

Page 65: ...forms 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...

Page 66: ...able levels of RF interference or to operate two networks of radios on separate frequencies When CM is queried it returns the operating channel mask based on what value BR is set to When BR is set to...

Page 67: ...FFFF FFFF FFFF Australia 0x00 0000 0000 0000 01FF FFFF FFFF 0x00 0000 0000 0000 0000 00FF FFFF New Zealand 0x00 0000 0000 0000 01FF FFFF FFFF 0x00 0000 0000 0000 0000 0000 07FF Brazil 0x00 0000 001F F...

Page 68: ...es that have the same network identifier and channel configured When receiving a packet the device check this after the preamble ID If you are using Original equipment manufacturer OEM network IDs 0xF...

Page 69: ...put power The following table shows the typical values over supply voltage If using a USB interface board with an XBee PRO SX module you must supply external DC power Power supply Output power PL 3 3...

Page 70: ...BC Bytes Transmitted You can reset the counter to any 32 bit value by appending a hexadecimal parameter to the command Parameter range 0 0xFFFFFFFF Default N A N A 0 after reset DB Last Packet RSSI Re...

Page 71: ...xFFFF it does not count further events To reset the counter to any 16 bit unsigned value append a hexadecimal parameter to the command This value is volatile the value does not persist in the device s...

Page 72: ...A Network commands The following commands are network commands CE Routing Messaging Mode The routing and messaging mode of the device A routing device repeats broadcasts Indirect Messaging Coordinator...

Page 73: ...range 0 0x20 Default 0 NH Network Hops The maximum number of hops expected to be seen in a network route This value does not limit the number of hops allowed but it is used to calculate timeouts wait...

Page 74: ...ange 0 0xFFFFFFFF read only Default Set in the factory SL Serial Number Low Displays the lower 32 bits of the unique IEEE 64 bit RF extended address assigned to the XBee in the factory The 64 bit sour...

Page 75: ...es the transmit options for Transparent mode The device s transmit options The device uses these options for all transparent transmissions API transmissions can override this using the TxOptions field...

Page 76: ...character A carriage return or a comma automatically ends the command Default 0x20 an ASCII space character NT Network Discovery Back off Sets or displays the network discovery back off parameter for...

Page 77: ...data transmissions If you set this value to 0x12 loopback Cluster ID the destination node echoes any transmitted packet back to the source device Supported Cluster IDs 0x11 Transparent data default 0...

Page 78: ...hat support DigiMesh Parameter range Any 64 bit address Default N A DN Discover Node Resolves an NI Node identifier string to a physical address case sensitive The following events occur after DN disc...

Page 79: ...character Broadcast an ND command to the network If the command includes an optional node identifier string parameter only those devices with a matching NI string respond without a random offset delay...

Page 80: ...rame each response returns as a separate AT Command Response 0x88 or Remote Command Response 0x97 frame respectively The data consists of the bytes in the previous list without the carriage return del...

Page 81: ...any value within 0x4B0 0x2580 and 0x4B00 0x1C9468 as an actual baud rate When the host sends a value above 0x4B0 the firmware stores the closest interface data rate represented by the number in the B...

Page 82: ...5 38400 6 57600 7 115200 8 230400 9 460800 10 921600 Default 3 NB Parity Set or read the serial parity settings for UART communications Parameter range 0x00 0x02 Parameter Description 0x00 No parity...

Page 83: ...control threshold De assert CTS when FT bytes are in the UART receive buffer Re assert CTS when less than FT 16 bytes are in the UART receive buffer Parameter range 0x11 0x16F bytes Default 0x13F API...

Page 84: ...scription 0 API disabled operate in Transparent mode 1 API enabled 2 API enabled with escaped control characters Default 0 AO API Options The API data frame output format for RF packets received Use A...

Page 85: ...ADC 3 Digital input 4 Digital output low 5 Digital output high Default 1 D1 DIO1 AD1 Sets or displays the DIO1 AD1 configuration pin 32 Parameter range 0 2 5 Parameter Description 0 Disabled 1 N A 2 A...

Page 86: ...tal output high Default 0 D3 DIO3 AD3 Sets or displays the DIO3 AD3 configuration pin 30 Parameter range 0 2 5 Parameter Description 0 Disabled 0 Unmonitored digital input 1 N A 2 ADC 3 Digital input...

Page 87: ...IATED_INDICATOR Sets or displays the DIO5 ASSOCIATED_INDICATOR configuration pin 28 Parameter range 0 1 3 5 Parameter Description 0 Disabled 1 Associate LED indicator blinks when associated 2 N A 3 Di...

Page 88: ...Disabled 1 CTS flow control 2 N A 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 transmit 0...

Page 89: ...displays the DIO9 ON_SLEEP configuration pin 26 Parameter range 0 1 3 5 Parameter Description 0 Disabled 1 ON SLEEP output 2 N A 3 Digital input 4 Digital output low 5 Digital output high Default 1 P0...

Page 90: ...tion Sets or displays the DIO11 PWM1 configuration pin 8 When configured as a PWM1 output you can use M1 to set the PWM duty cycle Parameter range 0 5 0 6 Parameter Description 0 Disabled 1 32 768 kHz...

Page 91: ...abled Default 1 P4 DIO14 DIN Sets or displays the DIO14 DIN CONFIG configuration pin 4 Sets or displays the DIO14 DIN configuration pin 4 The device enters Command mode at 9600 baud if you enable DIN...

Page 92: ...17 Parameter range 0 1 0 1 4 5 Parameter Description 0 Disabled 1 SPI_MISO 2 N A 3 N A 4 Digital output low 5 Digital output high Default 1 P6 SPI_MOSI Configuration Sets or displays the DIO16 SPI_MO...

Page 93: ...er Description 0 Disabled 1 SPI_SSEL 2 N A 3 N A 4 Digital output low 5 Digital output high Default 1 P8 DIO18 SPI_SCLK Sets or displays the DIO18 SPI_SCLK configuration pin 14 Parameter range 1 2 4 5...

Page 94: ...eter range 0x0 0xFFFFF Default 0xFFFFF PR Pull up Down Resistor Enable PR and PD only affect lines that are configured as digital inputs or disabled The following table defines the bit field map for P...

Page 95: ...14 DIO13 DOUT 3 15 DIO15 SPI_MISO 17 16 DIO16 SPI_MOSI 16 17 DIO17 SPI_SSEL 15 18 DIO18 SPI_SCLK 14 19 DIO19 SPI_ATTN 12 Parameter range 0 0xFFFFF bit field Default 0xFFFFF M0 PWM0 Duty Cycle The duty...

Page 96: ...other nodes Parameter range 0x14 0xFF x 10 ms Default 0 RP RSSI PWM Timer The PWM timer expiration in 0 1 seconds RP sets the duration of pulse width modulation PWM signal output on the RSSI pin The...

Page 97: ...t IC is a bitmask you can use to enable or disable edge detection on individual digital I O lines Only DIO0 through DIO12 can be sampled using a Change Detect Set unused bits to 0 Bit I O line Module...

Page 98: ...e device pin see D0 DIO0 AD0 D9 DIO9 ON_SLEEP P0 DIO10 RSSI PWM0 Configuration P2 DIO12 Configuration WARNING If you set IR to 1 or 2 the device will not keep up and many samples will be lost Paramete...

Page 99: ...ge 0 1 Parameter Description 0 Disabled 1 Enabled Default 1 IA I O Input Address The source address of the device to which outputs are bound Setting all bytes to 0xFF disables I O line passing Setting...

Page 100: ...t Specifies how long pin D3 holds a given value before it reverts to configured value If set to 0 there is no timeout Parameter range 0 0x1770 x 100 ms Default 0 T4 D4 Output Timeout Specifies how lon...

Page 101: ...there is no timeout Parameter range 0 0x1770 x 100 ms Default 0 T8 D8 Timeout Specifies how long pin D8 holds a given value before it reverts to configured value If set to 0 there is no timeout Param...

Page 102: ...er range 0 0x1770 x 100 ms Default 0 Q3 P3 Timeout Specifies how long pin P3 holds a given value before it reverts to configured value If set to 0 there is no timeout Parameter range 0 0x1770 x 100 ms...

Page 103: ...rt mode is always awake but can effectively communicate with SM8 nodes Synchronized Cyclic Sleep nodes sleep for SP and wake for ST time Synchronous modes are unavailable if BR 0 and are incompatible...

Page 104: ...p bit field options are defined Bit Option 0 Preferred sleep coordinator setting this bit causes a sleep compatible device to always act as sleep coordinator 1 Non sleep coordinator setting this bit c...

Page 105: ...ps per cycle Parameter range 0x1 0x15F900 x 10 ms Default 0x12C 3 seconds ST Wake Time Sets or displays the wake time of the device For devices in asynchronous sleep ST defines the amount of time that...

Page 106: ...T commands are Diagnostic sleep status timing commands SS Sleep Status Queries a number of Boolean values that describe the device s status Bit Description 0 This bit is true when the network is in it...

Page 107: ...ized to in 1 ms units If the device has not been synchronized then OW returns the value of ST If the device synchronizes with a sleeping router network OW may differ from ST Parameter range N A Defaul...

Page 108: ...I Default 0x2B the ASCII plus character CT Command Mode Timeout Sets or displays the Command mode timeout parameter If a device does not receive any valid commands within this time period it returns t...

Page 109: ...evices Parameter range 0 0xFFFFFFFF read only Default 0xF0000 NP Maximum Packet Payload Bytes Reads the maximum number of RF payload bytes that you can send in a transmission Note NP returns a hexadec...

Page 110: ...AT commands Firmware version information commands XBee XBee PRO SX RF Module User Guide 110 Parameter range N A Default N A...

Page 111: ...Operate in API mode API mode overview 112 Use the AP command to set the operation mode 112 API frame format 112 API frames 115 XBee XBee PRO SX RF Module User Guide 111...

Page 112: ...or when you need to know which node a data packet was sent from The device communicates UART data in packets also known as API frames This mode allows for structured communications with serial devices...

Page 113: ...more information on using this API mode see the Escaped Characters and API Mode 2 in the Digi Knowledge base API escaped operating mode works similarly to API mode The only difference is that when wor...

Page 114: ...2E FF FE 02 4E 49 6D The length field has a two byte value that specifies the number of bytes in the frame data field It does not include the checksum field Length field The length field is a two byt...

Page 115: ...6F Data packet B8 Checksum To calculate the check sum you add all bytes of the packet excluding the frame delimiter 7E and the length the second and third bytes 7E 00 0A 01 01 50 01 00 48 65 6C 6C 6F...

Page 116: ...al interface UART or SPI when you send a 0x08 AT Command Request or 0x09 AT Command Queue Request to read or set a device parameter To disable the 0x88 AT Command Response set the frame ID to 0 in the...

Page 117: ...s The following image shows the API frame exchanges that take place on the serial interface when you send a 0x17 Remote AT Command frame The 0x97 Remote AT Command Response is always generated and you...

Page 118: ...ude the following section of code on a host microprocessor that handles serial API frames that are sent out the device s DOUT pin void XBee_HandleRxAPIFrame _apiFrameUnion papiFrame switch papiFrame a...

Page 119: ...rame data fields Offset Description Frame type 3 0x00 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 Destination a...

Page 120: ...PRO SX RF Module User Guide 120 Frame data fields Offset Example Destination address MSB 5 0x00 6 0x13 7 0xA2 8 0x00 9 0x40 10 0x52 11 0xC5 LSB 12 0x07 Options 13 0x00 RF data 14 0x54 15 0x78 16 0x44...

Page 121: ...ing table provides the contents of the frame For details on frame structure see API frame specifications Frame data fields Offset Description Frame type 3 0x08 Frame ID 4 AT command 5 6 Command name t...

Page 122: ...structure see API frame specifications Frame data fields Offset Description Frame type 3 0x09 Frame ID 4 Identifies the data frame for the host to correlate with a subsequent response If set to 0 the...

Page 123: ...Operate in API mode API frames XBee XBee PRO SX RF Module User Guide 123 Frame data fields Offset Example AT command 5 0x42 B 6 0x44 D Parameter value BD7 115200 baud 7 0x07 Checksum 8 0x68...

Page 124: ...educes the RF payload by two bytes per intermediate hop in the source route Format The following table provides the contents of the frame For details on the frame structure see API frame format Frame...

Page 125: ...nation network address MSB 13 0xFF LSB 14 0xFE Broadcast radius 15 0x00 Options 16 0x00 RF data 17 0x54 18 0x78 19 0x44 20 0x61 21 0x74 22 0x61 23 0x30 24 0x41 Checksum 25 0x13 If you enable escaping...

Page 126: ...e specifications Frame data fields Offset Description Frame type 3 0x11 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 resp...

Page 127: ...oad TxData Frame data fields Offset Example Start delimiter 0 0x7E Length MSB 1 0x00 LSB 2 0x1A Frame type 3 0x11 Frame ID 4 0x01 64 bit destination address MSB 5 0x00 6 0x13 7 0xA2 8 0x00 9 0x01 10 0...

Page 128: ...Operate in API mode API frames XBee XBee PRO SX RF Module User Guide 128 Frame data fields Offset Example Data payload 23 0x54 24 0x78 25 0x44 26 0x61 27 0x74 28 0x61 Checksum 29 0xA6...

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

Page 130: ...imiter 0 0x7E 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 Remo...

Page 131: ...s of the frame For details on frame structure see API frame specifications Frame data fields Offset Description Frame type 3 0x8A Status 4 0x00 Hardware reset 0x01 Watchdog timer reset 0x0B Network wo...

Page 132: ...red 16 bit destination address 5 The 16 bit Network Address where the packet was delivered if successful If not successful this address is 0xFFFD destination address unknown 6 Transmit retry count 7 T...

Page 133: ...ode API frames XBee XBee PRO SX RF Module User Guide 133 Frame Fields Offset Example Frame ID 4 0x47 Reserved 5 0xFF 6 0xFE Transmit retry count 7 0x00 Delivery status 8 0x00 Discovery status 9 0x02 C...

Page 134: ...ount 10 The number 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 1...

Page 135: ...2 0x2A Frame type 3 0x8D Source event 4 0x12 Length 5 0x27 Timestamp MSB 6 0x9C 7 0x93 8 0x81 LSB 9 0x7F ACK timeout count 10 0x00 TX blocked count 11 0x00 Reserved 12 0x00 Destination address MSB 13...

Page 136: ...Module User Guide 136 Frame data fields Offset Example Responder address MSB 29 0x00 30 0x13 31 0xA2 32 0x00 33 0x40 34 0x52 35 0xBB LSB 36 0xBB Receiver address MSB 37 0x00 38 0x13 39 0xA2 40 0x00 41...

Page 137: ...ame For details on frame structure see API frame specifications Frame data fields Offset Description Frame type 3 0x8E Format ID 4 Byte reserved to indicate the format of additional packet information...

Page 138: ...e PRO SX RF Module User Guide 138 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...

Page 139: ...Received Signal Strength Indicator of the last hop The Hexadecimal equivalent of dBm value For example if RX signal strength is 40 dBm then 0x28 40 decimal is returned Options 13 Bit field bit 0 Pack...

Page 140: ...rame data fields Offset Example Length MSB 1 0x00 LSB 2 0x11 Frame type 3 0x80 64 bit source address MSB 4 0x00 5 0x13 6 0xA2 7 0x00 8 0x40 9 0x52 10 0xC5 LSB 11 0x07 RSSI 12 0x28 Options 13 0x01 Rece...

Page 141: ...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 command Command status 7 0 OK 1 ERROR 2...

Page 142: ...Operate in API mode API frames XBee XBee PRO SX RF Module User Guide 142 Frame data fields Offset Example Command data Checksum 8 0xF0...

Page 143: ...The following table provides the contents of the frame For details on frame structure see API frame specifications Frame data fields Offset Description Frame type 3 0x89 Frame ID 4 Identifies the Lega...

Page 144: ...iption Frame type 3 0x90 64 bit source address 4 11 The sender s 64 bit address MSB first LSB last Reserved 12 13 Reserved Receive options 14 Bit field 0x01 Packet acknowledged 0x02 Packet was a broad...

Page 145: ...r Guide 145 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 0...

Page 146: ...Destination endpoint 15 Endpoint of the destination where the message is addressed Cluster ID 16 17 The Cluster ID where the frame is addressed Profile ID 18 19 The Profile ID where the fame is addres...

Page 147: ...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 Source endpoint 14 0xE0 Destination endpoint 15 0xE0 Cluster ID 16 0x22 17 0x11 Profil...

Page 148: ...rved 64 bit remote address 17 24 Indicates the 64 bit address of the remote device that transmitted the Node Identification Indicator frame NI string 25 26 Node identifier string on the remote device...

Page 149: ...ng sends a Node Identification all devices on the network receive the following node identification indicator If you press the commissioning button on a remote router device with 64 bit address 0x0013...

Page 150: ...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 ID 31 0xC1 32 0x05 Dig...

Page 151: ...scription Frame type 3 0x97 Frame ID 4 This is the same value that is passed in to the request 64 bit source remote address 5 12 The address of the remote device returning this response Reserved 13 14...

Page 152: ...Example 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 16 bit source remote address MSB 13 0x7D LSB 14 0x84 AT commands 15 0x5...

Page 153: ...ioning and diagnostics 154 Local configuration 154 Remote configuration 154 Establish and maintain network links 155 Test links in a network loopback cluster 156 Test links between adjacent devices 15...

Page 154: ...ce 2 The correct command options value 3 Optionally the command and parameter data 4 If you want a command response set the Frame ID field to a non zero value The firmware only supports unicasts of re...

Page 155: ...se all nodes in the network to build routes to the aggregator node You can optionally use the AG command to automatically update the DH DL registers to match the MAC address of the aggregator node The...

Page 156: ...elow Example three This example shows how to cause all devices to update their DH and DL registers to the MAC address of the sending device In this case assume you are using a device with a serial num...

Page 157: ...ity of a link between two adjacent modules in a network You can use the Test Link Request Cluster ID to send a number of test packets between any two devices in a network To clarify the example we ref...

Page 158: ...ets Send the following API packet to the serial interface of device A In the following example packet whitespace marks fields bold text is the payload portion of the packet 7E 0020 11 01 0013A20040521...

Page 159: ...ces on a network When you send the ND command 1 The device sends a broadcast ND command through the network 2 All devices that receive the command send a response that includes their addressing inform...

Page 160: ...ee Route Information Packet frame 0x8D Trace route example Suppose that you successfully unicast a data packet with trace route enabled from device A to device E through devices B C and D The followin...

Page 161: ...y and repair marginal links The Commissioning Pushbutton The XBee XBee PRO SX RF Module supports a set of commissioning and LED functions to help you deploy and commission devices These functions incl...

Page 162: ...ond All devices in API operating mode that receive this transmission send a Node Identification Indicator frame 0x95 out their UART 2 Not configured for synchronous sleep No effect 2 Configured for sy...

Page 163: ...is operating properly 1 4 5 Off The device is in a low power mode 1 4 5 On blinking The device has power is awake and is operating properly 7 On solid The network is asleep or the device has not synch...

Page 164: ...tionality 2 Analog input A D pins or PWM output PWM pins 3 Digital input monitored 4 Digital output low 5 Digital output high 6 9 Alternate functionality where applicable The following table provides...

Page 165: ...return delimited list containing the following fields Field Name Description 1 Sample sets Number of sample sets in the packet Always set to 1 2 Digital channel mask Indicates which digital I O lines...

Page 166: ...t a periodic rate Use the IR command to set the periodic sample rate n To disable periodic sampling set IR to 0 n For all other IR values the firmware samples data when IR milliseconds elapse and the...

Page 167: ...d needed to wait for the next IR sample period Note Use caution when combining Change Detect sampling with sleep modes IC only causes a sample to be generated if the change takes place during a wake p...

Page 168: ...a particular device s input This does not affect the ability of the device to receive I O line data from other devices only its ability to update enabled outputs Set the IA parameter to 0xFFFF broadc...

Page 169: ...ase Device B Device B does not periodically sample instead it monitors DIO3 for a binary change When it detects a change on that pin it generates a sample and transmits it as a broadcast to all device...

Page 170: ...General Purpose Flash Memory General Purpose Flash Memory 171 Access General Purpose Flash Memory 171 General Purpose Flash Memory commands 172 XBee XBee PRO SX RF Module User Guide 170...

Page 171: ...es see Operate in API mode To issue a GPM command format the payload of an explicit API frame as follows Byte offset in payload Number of bytes Field name General field description 0 1 GPM_CMD_ID Spec...

Page 172: ...rmation about commands that interact with GPM PLATFORM_INFO_REQUEST 0x00 A PLATFORM_INFO_REQUEST frame can be sent to query details of the GPM structure Field name Command specific description GPM_CMD...

Page 173: ...00 0000 EB ERASE 0x01 The ERASE command erases writes all bits to binary 1 one or all of the GPM flash blocks You can also use the ERASE command to erase all blocks of the GPM by setting the GPM_NUM_B...

Page 174: ...A200407402AC FFFE E6 E6 0023 C105 C1 81 00 002A 0000 0000 39 WRITE 0x02 and ERASE_THEN_WRITE 0x03 The WRITE command writes the specified bytes to the GPM location specified Before writing bytes to a G...

Page 175: ...le To write 15 bytes of incrementing data to flash block 22 of a target radio with serial number of 0x0013a200407402ac a WRITE packet should be formatted as follows spaces added to delineate fields 7E...

Page 176: ...ART_INDEX Matches the parameter passed in the request frame GPM_NUM_BYTES The number of bytes in the GPM_DATA field GPM_DATA The bytes read from the GPM block specified Example To read 15 bytes of pre...

Page 177: ...t bit indicates the GPM does not contain a valid firmware image A 0 in the least significant bit indicates the GPM does contain a valid firmware image All other bits are reserved at this time GPM_BLOC...

Page 178: ...image previously loaded into the GPM on a target device with serial number 0x0013a200407402ac format a FIRMWARE_VERIFY packet as follows spaces added to delineate fields 7E 001C 11 01 0013A200407402A...

Page 179: ...application 2 Verify the new application 3 Install the application Distribute the new application The first phase of performing an over the air update on a device is transferring the new firmware file...

Page 180: ...a Install the application When the entire ebin file is uploaded to the GPM of the target node you can issue a FIRMWARE_ VERIFY_AND_INSTALL command Once the target receives the command it verifies the...

Page 181: ...Regulatory information FCC United States 182 Industry Canada IC 194 ACMA Australia 195 RSM New Zealand 195 Brazil Anatel 195 XBee XBee PRO SX RF Module User Guide 181...

Page 182: ...sed device complies with Part 15 of the FCC Rules Operation is subject to the following two conditions i this device may not cause harmful interference and ii this device must accept any interference...

Page 183: ...approved for use in fixed base station and mobile applications When the antenna is mounted at least 34 cm from nearby persons the application is considered a mobile application Portable applications...

Page 184: ...Type Connector Gain Required antenna cable loss Application A09 HSM 7 Straight half wave RPSMA 2 1 dBi 0 4 dB Fixed mobile A09 HASM 675 Articulated half wave RPSMA 2 1 dBi 0 4 dB Fixed mobile A09 HAB...

Page 185: ...xed mobile A09 Y14NF 14 element Yagi 14 0 dBi N 9 9 dB Fixed mobile A09 Y6TM 2 element Yagi 6 1 dBi RPTNC 2 0 dB Fixed mobile A09 Y7TM 3 element Yagi 7 1 dBi RPTNC 3 0 dB Fixed mobile A09 Y8TM 4 eleme...

Page 186: ...on 7 1 dBi N 1 9 dB Fixed A09 F8NF M Fiberglass base station 8 1 dBi N 2 9 dB Fixed A09 F0SM Fiberglass base station 0 dBi RPSMA Fixed A09 F1SM Fiberglass base station 1 0 dBi RPSMA Fixed A09 F2SM Fib...

Page 187: ...tation 7 1 dBi RPSMA 1 9 dB Fixed A09 W7TM Wire base station 7 1 dBi RPTNC 1 9 dB Fixed Dome antennas All antenna part numbers followed by an asterisk are not available from Digi Consult with an anten...

Page 188: ...Heavy duty quarter wave straight 1 9 dBi RPSMA Fixed mobile A09 QBMM P6I Quarter wave w 6 pigtail 1 9 dBi MMCX Fixed mobile A09 QHSM 2 2 straight 1 9 dBi RPSMA Fixed mobile A09 QHRSM 2 2 right angle 1...

Page 189: ...Articulated half wave RPSMA 2 1 dBi 0 4 dB Fixed mobile A09 HABMM P5I Swivel half wave with 5 pigtail MMCX 2 1 dBi 0 4 dB Fixed mobile A09 HBMM P5I Straight half wave with 6 pigtail MMCX 2 1 dBi 0 4 d...

Page 190: ...lement Yagi 15 1 dBi N 0 7 dB Fixed mobile A09 Y15NF ALT 15 element Yagi 15 1 dBi N 0 7 dB Fixed mobile A09 Y6TM 2 element Yagi 6 1 dBi RPTNC Fixed mobile A09 Y7TM 3 element Yagi 7 1 dBi RPTNC Fixed m...

Page 191: ...F4NF Fiberglass Base Station 4 1 dBi N Fixed A09 F5NF M Fiberglass Base Station 5 1 dBi N Fixed A09 F6NF Fiberglass Base Station 6 1 dBi N Fixed A09 F7NF Fiberglass Base Station 7 1 dBi N Fixed A09 F8...

Page 192: ...7 dB Fixed A09 W7 Wire Base Station 7 1 dBi RPN Fixed A09 W7SM Wire Base Station 7 1 dBi RPSMA Fixed A09 W7TM Wire Base Station 7 1 dBi RPTNC Fixed Dome antennas All antenna part numbers followed by...

Page 193: ...Heavy duty quarter wave straight 1 9 dBi RPSMA Fixed mobile A09 QBMM P6I Quarter wave w 6 pigtail 1 9 dBi MMCX Fixed mobile A09 QHSM 2 2 straight 1 9 dBi RPSMA Fixed mobile A09 QHRSM 2 2 right angle 1...

Page 194: ...and FCC Part 15 Sub B Unintentional Radiators ICES 003 is the same as FCC Part 15 Sub B and Industry Canada accepts FCC test report or CISPR 22 test report for compliance with ICES 003 Transmitters f...

Page 195: ...a or b below a have a company presence in Australia b have a company distributor agent in Australia that will sponsor the import of the end product Contact Digi for questions related to locating a con...

Page 196: ...do mesmo tipo e n o pode causar interfer ncia a sistemas operando em car ter prim rio SX ANATEL Brazil for XK9X DMS 1 XBee SX RF Module Dev Kit XK9X DMS 1 The XBee SX RF modules models noted below co...

Page 197: ...es do mesmo tipo e n o pode causar interfer ncia a sistemas operando em car ter prim rio ANATEL Brazil for XBee SX radio products XB9X The XBee SX RF modules models noted below comply with Brazil ANA...

Page 198: ...F Module User Guide 198 Resolu o 506 ANATEL Este equipamento opera em car ter secund rio isto n o tem direito a prote o contra interfer ncia prejudicial mesmo de esta es do mesmo tipo e n o pode causa...

Page 199: ...ed pads to allow for easy solder attach inspection The pads are all located on the edge of the module so there are no hidden solder joints on these modules Recommended footprint and keepout 200 Design...

Page 200: ...We designed the XBee XBee PRO SX RF Module for surface mounting on the OEM printed circuit board PCB It has castellated pads around the edges and one ground pad on the bottom Mechanical drawings inclu...

Page 201: ...he ground pad Note The ground pad is unique to the XBee XBee PRO XTC and SX modules This footprint is not compatible with other SMT XBees Although the underside of the device is mostly coated with sol...

Page 202: ...ely noisy it may degrade device performance and reliability To help reduce noise we recommend placing both a 1 uF and 100 pF capacitor as near to VCC as possible If you use a switching regulator we re...

Page 203: ...microstrip example below because it is simpler to design and generally requires less area on the host PCB than coplanar waveguide We do not recommend using a stripline RF trace because that requires r...

Page 204: ...ction Number Description 1 XBee pin 36 2 50 microstrip trace 3 Back off ground fill at least twice the distance between layers 1 and 2 4 RF connector 5 Stitch vias near the edges of the ground plane 6...

Page 205: ...ragraphs 5 through 7 c The time between the opening of the sealed bag and the start of the reflow process cannot exceed 168 hours if condition b is met d Baking is required if conditions b or c are no...

Page 206: ...PCB design and manufacturing Rework XBee XBee PRO SX RF Module User Guide 206 CAUTION Any modification to the device voids the warranty coverage and certifications...

Search results

Summary of Contents for Digi XBee SX

Reviews:

Related manuals for Digi XBee SX

Brands by name

Popular brands

Digi Digi XBee SX, User Manual

Search results

Summary of Contents for Digi XBee SX

Reviews:

Related manuals for Digi XBee SX

Brands by name

Popular brands