Digi XBee DigiMesh 2.4 User Manual Download Page 108

Page: 108 / 157

Operate in API mode

API mode overview

XBee/XBee-PRO DigiMesh 2.4 RF Module User Guide

108

Frame type

is the API frame type identifier. It determines the type of API frame and indicates

how the Data field organizes the information.

Data

contains the data itself. This information and its order depend on the what type of frame

that the Frame type field defines.

The XBee modules support the following API frames:

API Frame Names

API ID

AT Command

0x08

AT Command - Queue Parameter Value

0x09

Zigbee Transmit Request

0x10

Explicit Addressing Zigbee Command Frame

0x11

Remote Command Request

0x17

Create Source Route

0x21

AT Command Response

0x88

Modem Status

0x8A

Zigbee Transmit Status

0x8B

Zigbee Receive Packet (AO=0)

0x90

Zigbee Explicit Rx Indicator (AO=1)

0x91

Zigbee I/O Data Sample Rx Indicator

0x92

XBee Sensor Read Indicator (AO=0)

0x94

Node Identification Indicator (AO=0)

0x95

Remote Command Response

0x97

Extended Modem Status

0x98

Over-the-Air Firmware Update Status

0xA0

Route Record Indicator

0xA1

Many-to-One Route Request Indicator

0xA3

Checksum

Checksum is the last byte of the frame and helps test data integrity. It is calculated by taking the hash
sum of all the API frame bytes that came before it, except the first three bytes (start delimiter and
length).

The device does not process frames sent through the serial interface with incorrect checksums, and
ignores their data.

Calculate and verify checksums

To calculate the checksum of an API frame:

Summary of Contents for XBee DigiMesh 2.4

Page 1: ...XBee XBee PRO DigiMesh 2 4 Radio Frequency RF Module User Guide...

Page 2: ...ct 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 expressed or implied including but not...

Page 3: ...nting considerations 17 Hardware diagram 18 Pin signals 19 Notes 20 Recommended pin connections 20 Design notes 20 Power supply design 20 Board layout 20 Antenna performance 21 Keepout area 21 DC char...

Page 4: ...worked devices Network commissioning and diagnostics 38 Local configuration 38 Remote configuration 38 Establish and maintain network links 39 Build aggregate routes 39 DigiMesh routing examples 39 Re...

Page 5: ...ator 64 Preferred sleep coordinator option 64 Resolution criteria and selection option 64 Commissioning Pushbutton option 65 Auto early wake up sleep option 66 Select sleep parameters 66 Start a sleep...

Page 6: ...y Options 81 CI Cluster ID 81 DE command 82 SE Source Endpoint 82 Diagnostic addressing commands 82 N Network Discovery Timeout 82 Addressing discovery configuration commands 82 AG Aggregator Support...

Page 7: ...ode options 102 CC Command Character 102 CT Command Mode Timeout 102 CN Exit Command mode 103 GT Guard Times 103 Firmware version information commands 103 VL Version Long 103 VR Firmware Version 103 H...

Page 8: ...ulatory information United States FCC 146 OEM labeling requirements 146 FCC notices 146 RF exposure statement 147 FCC approved antennas 2 4 GHz 147 Australia C Tick 153 Labeling requirements 153 Brazi...

Page 9: ...e devices The devices operate within the ISM 2 4 MHz frequency band These devices support routing table sizes of 32 nodes Networks larger than this send a route discovery before each transmission For...

Page 10: ...he center conductor The female RPSMA actually has a male center conductor We equip the XBee devices with an RPSMA female plug while the antenna is an RPSMA male jack The U FL connection allows for con...

Page 11: ...ovide the device s technical specifications Performance specifications 12 Power requirements 12 General specifications 12 Networking and security specifications 13 Regulatory conformity summary 13 XBe...

Page 12: ...b s 250 kb s Serial interface data rate software selectable 1200 bps 250 kb s devices also support non standard baud rates 1200 bps 250 kb s devices also support non standard baud rates Receiver sensi...

Page 13: ...ecifications for the devices Specification XBee XBee PRO Supported network topologies Mesh point to point point to multipoint peer to peer Mesh point to point point to multipoint peer to peer Number o...

Page 14: ...gulatory conformity summary XBee XBee PRO DigiMesh 2 4 RF Module User Guide 14 Specification XBee XBee PRO Brazil ANATEL 0369 15 1209 ANATEL 0378 15 1209 See Regulatory information for region specific...

Page 15: ...Mounting considerations 17 Hardware diagram 18 Pin signals 19 Design notes 20 DC characteristics 23 ADC operating characteristics 23 ADC timing and performance characteristics 24 XBee XBee PRO DigiMe...

Page 16: ...ee PRO DigiMesh 2 4 RF Module User Guide 16 Mechanical drawings The following figures show the mechanical drawings for the XBee XBee PRO DigiMesh 2 4 The drawings do not show antenna options The follo...

Page 17: ...ole module to mount into a receptacle so that you do not have to solder the module when you mount it to a board The development kits may contain RS 232 and USB interface boards that use two 20 pin rec...

Page 18: ...row receptacles Century Interconnect part number CPRMSL20 D 0 1 or equivalent n Surface mount single row receptacles Samtec part number SMM 110 02 SM S Note We recommend that you print an outline of...

Page 19: ...ther PWM output 0 RX signal strength indicator Digital I O 7 PWM DIO11 Either PWM output 1 Digital I O 11 8 Reserved Do not connect 9 DTR SLEEP_ RQ DIO8 Either Pin sleep control line or Digital I O 8...

Page 20: ...of operation including the Associate LED pin pin 15 and the Commissioning pin pin 20 The Associate LED pin flashes differently depending on the state of the module and a pushbutton attached to pin 20...

Page 21: ...tance Objects that are often overlooked include n metal poles n metal studs n structure beams n concrete which is usually reinforced with metal rods If you place the device inside a metal enclosure us...

Page 22: ...ntenna 2 Keep metal chassis or mounting structures in the keepout area at least 2 54 cm 1 in from the antenna 3 Maximize the distance between the antenna and metal objects that might be mounted in the...

Page 23: ...characteristics The following table displays the ADC timing and performance characteristics Symbols Parameter Condition Min Typical Max Units VREFH VREF analog to digital converter reference range 2...

Page 24: ...put pin Values greater than this amount may not fully charge the input circuitry of the ATD resulting in accuracy error 3The resolution is the ideal step size or 1LSB VREFH VREFL 1024 4Differential no...

Page 25: ...nditions 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 when using the SPI port Transparen...

Page 26: ...the radio network or when you need to know which node a data packet originated from The device communicates UART data in packets also known as API frames This mode allows for structured communication...

Page 27: ...has several advanced features such as advanced networking diagnostics and firmware upgrades Disadvantages n You cannot set or read the configuration of remote XBee devices in the network n You must fi...

Page 28: ...ta to its serial transmit buffer For the serial interface to report receive data on the RF network that data must meet the following criteria n ID match n Channel match n Address match Sleep modes Sle...

Page 29: ...from entering Command mode When you send the Command mode sequence the device sends OK out the UART pin The device may delay sending the OK if it has not transmitted all of the serial data it receive...

Page 30: ...ut a leading 0x for example FFFF or 0xFFFF Response to AT commands When reading parameters the device returns the current parameter value instead of an OK message Exit Command mode 1 Send the CN Exit...

Page 31: ...Configure the XBee XBee PRO DigiMesh 2 4 Software libraries 32 Configure the device using XCTU 32 XBee XBee PRO DigiMesh 2 4 RF Module User Guide 31...

Page 32: ...ce code and a collection of samples that help you develop Java applications to communicate with your XBee devices The XBee ANSI C Library project is a collection of portable ANSI C code for communicat...

Page 33: ...Serial communication Serial interface 34 UART data flow 34 Serial buffers 35 Serial flow control 36 XBee XBee PRO DigiMesh 2 4 RF Module User Guide 33...

Page 34: ...of the XBee XBee PRO DigiMesh 2 4 as shown in the following figure The figure shows system data flow in a UART interfaced environment Low asserted signals have a horizontal line over the signal name S...

Page 35: ...a continuous stream of RF data it does not transmit the data in the serial receive buffer until the device stops receiving RF data 2 For mesh networking firmware if the device transmits an RF data pa...

Page 36: ...al receive buffer fills with the number of bytes specified by the FT parameter the device de asserts CTS sets it high to signal the host device to stop sending serial data The device re asserts CTS wh...

Page 37: ...ork commissioning and diagnostics 38 Establish and maintain network links 39 Test links in a network loopback cluster 40 Test links between adjacent devices 41 Monitor I O lines 48 XBee XBee PRO DigiM...

Page 38: ...d 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 remote commands You cannot broadcast remote commands XCTU has a Fram...

Page 39: ...ess of the aggregator node The AG command requires a 64 bit parameter The parameter indicates the current value of the DH DL registers on a device typically you should replace this value with the 64 b...

Page 40: ...0x0013A200 4052C507 as a network aggregator and the sending device has a MAC address of 0x0013A200 F5E4D3B2 To update the DH and DL registers to the sending device s MAC address 1 Replace the aggrega...

Page 41: ...in a network To clarify the example we refer to device A and device B in this section To request that device B perform a link test against device A 1 Use device A in API mode AP 1 to send an Explicit...

Page 42: ...tespace marks fields bold text is the payload portion of the packet 7E 0020 11 01 0013A20040521234 FFFE E6 E6 0014 C105 00 00 0013A2004052ABCD 0028 03E8 EB When the test is finished the following API...

Page 43: ...ces that receive the command send a response that includes their addressing information node identifier string and other relevant information For more information on the node identifier string see NI...

Page 44: ...successful MAC transmission from device D to device E device D transmits a Route Information Packet frame to device A through device C and device B When device A receives the Route Information packet...

Page 45: ...associated LED functions The following diagram shows how the hardware can support these features To support the Commissioning Pushbutton and its associated LED functions connect a pushbutton and an L...

Page 46: ...ameters to default values Use the Commissioning Pushbutton Use the CB command to simulate button presses in software Send CB with a parameter set to the number of button presses to perform For example...

Page 47: ...low blinking 500 ms blink time The device is acting as the network sleep coordinator and is operating properly 7 8 On fast blinking 250 ms blink time The device is properly synchronized with the netwo...

Page 48: ...mmand for a particular pin Device pin name Device pin number Configuration command CD DIO12 4 P2 PWM0 RSSI DIO10 6 P0 PWM1 DIO11 7 P1 DTR SLEEP_RQ DIO8 9 D8 AD4 DIO4 11 D4 CTS DIO7 12 D7 ON SLEEP DIO9...

Page 49: ...3 and 5 are enabled as digital I O 1 Analog channel mask Indicates which lines have analog inputs enabled for sampling Each bit in the analog channel mask corresponds to one analog input channel bit 0...

Page 50: ...xpires and the device can resume sleeping For more information about setting sleep modes see Sleep modes Detect digital I O changes You can configure devices to transmit a data sample immediately when...

Page 51: ...devices Monitor I O lines XBee XBee PRO DigiMesh 2 4 RF Module User Guide 51 Use IR in conjunction with IC in this instance since IR generates an I O sample upon wakeup and ensures that the change is...

Page 52: ...Network configurations DigiMesh networking 53 Network identifiers 54 Routing 55 XBee XBee PRO DigiMesh 2 4 RF Module User Guide 52...

Page 53: ...ly when needed n Selective acknowledgments Only the destination node will reply to route requests n Reliable delivery Reliable delivery of data is accomplished by means of acknowledgments n Sleep mode...

Page 54: ...same ID value and using the same channel with the same CH value n A device can only transmit data to other devices within the same network with the same ID value and using the same channel with the s...

Page 55: ...er reaches its destination or forwards to an intermediate router that routes the message on to its destination If a message has a broadcast address it is broadcast to all neighbors then all routers th...

Page 56: ...the destination During the test there were no route discoveries or failures Transmission timeouts When a device in API operating mode receives a Transmit Request 0x10 0x11 frame or a device in Transp...

Page 57: ...a known route When a device knows a route to a destination node the transmission time is largely a function of the number of hops and retries The timeout associated with a unicast assumes that the max...

Page 58: ...Synchronous cyclic sleep mode 61 The sleep timer 61 Sleep coordinator sleep modes in the DigiMesh network 61 Synchronization messages 62 Become a sleep coordinator 64 Select sleep parameters 66 Start...

Page 59: ...ng the CE command This prevents the node from attempting to route data Synchronous modes Synchronous sleep makes it possible for all nodes in the network to synchronize their sleep and wake times All...

Page 60: ...ne pin 13 is asserted high when the device wakes and is de asserted low when the device sleeps If you use the D7 command to enable hardware flow control the CTS pin asserts low when the device wakes a...

Page 61: ...cyclic sleep mode and Asynchronous cyclic sleep with pin wake up modes SM 4 or SM 5 it starts a sleep timer time until sleep n If the device receives any data serially or by RF link the timer resets...

Page 62: ...sync 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 deplo...

Page 63: ...Sleep modes Synchronization messages XBee XBee PRO DigiMesh 2 4 RF Module User Guide 63...

Page 64: ...sleep 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 config...

Page 65: ...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 values different from those that the ne...

Page 66: ...eters 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 sl...

Page 67: ...LED A 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...

Page 68: ...e with 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 p...

Page 69: ...ring 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 su...

Page 70: ...Use the 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 A...

Page 71: ...Addressing discovery configuration commands 82 Security commands 84 Serial interfacing commands 85 I O settings commands 88 I O sampling commands 96 Sleep commands 98 Diagnostic sleep status timing co...

Page 72: ...d performs 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 paramete...

Page 73: ...Adjacent channel rejection is 23 dB The command uses 802 15 4 channel numbers Center frequency 2405 MHz CH 11 decimal 5 MHz Parameter range 0xB 0x1A Default 0xC 12 decimal ID Network ID Set or read t...

Page 74: ...parameter to 60 0x3C the device does not transmit if it detects a signal greater than 60 dBm on the channel ETSI compliance Europe Use the following settings for ETSI compliance Device Hex value Sets...

Page 75: ...ument to specify the time in milliseconds to scan all channels The device loops through all the available channels until the time elapses It returns the maximal energy on each channel a comma follows...

Page 76: ...a good frame with a valid MAC header on the RF interface Received MAC ACK packets do not increment this counter Once the number reaches 0xFFFF it does not count further events To reset the counter to...

Page 77: ...ower up sequence Parameter range 0 0xFFFF Default 0 H MAC Unicast One Hop Time The MAC unicast one hop time timeout in milliseconds If you change the MAC parameters it can change this value Parameter...

Page 78: ...of hops across the network This parameter limits the number of hops You can use this parameter to calculate the maximum network traversal time You must set this parameter to the same value on all nod...

Page 79: ...s We recommend that you set this value to 1 If you set this parameter to 0 it disables network ACKs Initially the device can find routes but a route will never be repaired if it fails Parameter range...

Page 80: ...s for transmissions in Transparent mode The destination address is also used for I O sampling in both Transparent and API modes 0x000000000000FFFF is the broadcast address Parameter range 0 0xFFFFFFFF...

Page 81: ...when it receives an ND command or API Node Identification Indicator 0x95 frame Use NO to suppress or include a self response to ND Node Discover commands When NO bit 1 1 a device performing a Node Di...

Page 82: ...as the source endpoint for all data transmissions The default value 0xE8 is the Digi data endpoint Parameter range 0 0xFF Default 0xE8 Diagnostic addressing commands The following AT command is a Dia...

Page 83: ...stination node When DN is sent in Command mode 1 The device sets DL and DH to the extended 64 bit address of the device with the matching NI string 2 The receiving device returns OK or ERROR 3 The dev...

Page 84: ...included based on NO settings CR If you send the FN command in Command mode after NT 100 ms overhead time the command ends by returning a carriage return represented by CR If you send the FN command...

Page 85: ...the serial interface baud rate for communication between the device s serial port and the host To request non standard baud rates with values above 0x80 you can use the Serial Console toolbar in XCTU...

Page 86: ...0x04 Parameter Description 0x00 No parity 0x01 Even parity 0x02 Odd parity 0x03 Mark parity forced high 0x04 Space parity forced low Default 0x00 RO Packetization Timeout Set or read the number of ch...

Page 87: ...Description 0 Transparent mode API mode is off All UART input and output is raw data and the device uses the ROparameter to delineate packets 1 API Mode Without Escapes The device packetizes all UART...

Page 88: ...ton presses that you want to simulate For example send CB1 to perform the action of pressing the Commissioning Pushbutton once Parameter range 0 4 Default N A D0 DIO0 AD0 Sets or displays the DIO0 AD0...

Page 89: ...gital output high 6 PTI_EN Default 0 D2 DIO2 AD2 Sets or displays the DIO2 AD2 configuration pin 18 Parameter range 0 2 5 Parameter Description 0 Disabled 1 N A 2 ADC 3 Digital input 4 Digital output...

Page 90: ...ation pin 11 Parameter range 0 2 5 Parameter Description 0 Disabled 1 N A 2 ADC 3 Digital input 4 Digital output low 5 Digital output high Default 0 D5 DIO5 AD5 ASSOCIATED_INDICATOR Sets or displays t...

Page 91: ...low control 2 N A 3 Digital input 4 Digital output low 5 Digital output high Default 0 D7 DIO7 CTS Sets or displays the DIO7 CTS configuration pin 12 Parameter range 0 1 3 7 Parameter Description 0 Di...

Page 92: ...sleep regardless of configuration of D8 Parameter range 0 1 3 5 Parameter Description 0 Disabled 1 N A 2 N A 3 Digital input 4 Digital output low 5 Digital output high Default 1 D9 ON_SLEEP Sets or di...

Page 93: ...l input 4 Digital output low 5 Digital output high Default 1 P1 DIO11 PWM1 Configuration Sets or displays the DIO11 PWM1 configuration pin 7 Parameter range 0 5 0 6 Parameter Description 0 Disabled 1...

Page 94: ...e defines the bit field map for PR and PD commands The bit field that configures the internal pull up resistor status for the I O lines If you set a PR bit to 1 it enables the pull up resistor 0 speci...

Page 95: ...D blink time If you use the D5 command to enable the Associate LED functionality DIO5 Associate pin this value determines the on and off blink times for the LED when the device has joined the network...

Page 96: ...I O use the IC command to force an immediate I O sample transmission when the DIO state changes If sleep is enabled the edge transition must occur during a wake period to trigger a change detect The d...

Page 97: ...specified by DT To enable periodic sampling set IR to a non zero value and enable the analog or digital I O functionality of at least one device pin see D0 DIO0 AD0 D9 ON_SLEEP P0 DIO10 RSSI PWM0 Con...

Page 98: ...range 0 1 4 5 7 8 Parameter Description 0 Normal 1 Asynchronous Pin Sleep In this mode the SLEEP_RQ line controls the sleep wake state of the device 2 N A 3 N A 4 Asynchronous Cyclic Sleep In this mod...

Page 99: ...Option 8 Always wake for ST time Default 0x2 non sleep coordinator SN Number of Cycles Between ON_SLEEP Set or read the number of sleep periods value This command controls the number of sleep periods...

Page 100: ...NH NN or MT the ST value raises automatically The maximum value is one hour 0x36EE80 ms Parameter range 0x1 0x36EE80 x 1 ms Default 0x7D0 3 seconds WH Wake Host Delay Sets or displays the wake host ti...

Page 101: ...5 This bit is true if you request that the node nominate itself as the sleep coordinator using the Commissioning Pushbutton or the CB2 command 6 This bit is true if the node is currently in deploymen...

Page 102: ...ode option commands CC Command Character The character value the device uses to enter Command mode The default value 0x2B is the ASCII code for the plus character You must enter it three times within...

Page 103: ...efore and after the command sequence characters of the Command mode sequence GT CC GT The period of silence prevents inadvertently entering Command mode Parameter range 0x2 0xCE4 x 1 ms Default 0x3E8...

Page 104: ...an send in a transmission Using APS encryption API transmit option bit enabled reduces the maximum payload size by 9 bytes Using source routing AR 0xFF further reduces the maximum payload size Note NP...

Page 105: ...Operate in API mode API mode overview 106 API frames 110 XBee XBee PRO DigiMesh 2 4 RF Module User Guide 105...

Page 106: ...PI modes disabled This is the default option AP 1 API operation AP 2 API operation with escaped characters only possible on UART The API data frame structure differs depending on what mode you choose...

Page 107: ...Escape n 0x11 XON n 0x13 XOFF Example Raw UART data frame before escaping interfering bytes 0x7E 0x00 0x02 0x23 0x11 0xCB 0x11 needs to be escaped which results in the following frame 0x7E 0x00 0x02...

Page 108: ...Response 0x88 Modem Status 0x8A Zigbee Transmit Status 0x8B Zigbee Receive Packet AO 0 0x90 Zigbee Explicit Rx Indicator AO 1 0x91 Zigbee I O Data Sample Rx Indicator 0x92 XBee Sensor Read Indicator...

Page 109: ...s 7E 00 0A 01 01 50 01 00 48 65 6C 6C 6F B8 Add these hex bytes 01 01 50 01 00 48 65 6C 6C 6F 247 Now take the result of 0x247 and keep only the lowest 8 bits which in this example is 0x47 the two far...

Page 110: ...80 and responses are always 0x80 or higher API frame name API ID AT Command 0x08 AT Command Queue Parameter Value 0x09 Transmit Request 0x10 Explicit Addressing Command Frame 0x11 Remote Command Reque...

Page 111: ...rface when a device sends a 0x10 or 0x11 Transmit Request to another device The device sends the 0x8B Transmit Status frame at the end of a data transmission unless you set the frame ID to 0 in the tr...

Page 112: ...Operate in API mode API frames XBee XBee PRO DigiMesh 2 4 RF Module User Guide 112...

Page 113: ...include 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 papiFr...

Page 114: ...at 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 0x08 Frame ID 4 AT command 5 6 C...

Page 115: ...on frame 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 ACK If set to 0...

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

Page 117: ...is only used for broadcast transmissions You can read the maximum number of payload bytes with the NP command Note Using source routing reduces the RF payload by two bytes per intermediate hop in the...

Page 118: ...ul hops Note 0x04 is the hex value when bit 2 is set and 0x08 is the hex value when bit 3 is set Set all other bits to 0 RF data 17 n Up to NP bytes per packet Sent to the destination device Example T...

Page 119: ...21 0x74 22 0x61 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...

Page 120: ...of the frame For details on the frame structure see API frame specifications Frame data fields Offset Description Frame type 3 0x11 Frame ID 4 Identifies the data frame for the host to correlate with...

Page 121: ...ng the path No trace route frames are generated for successful hops Note 0x04 is the hex value when bit 2 is set and 0x08 is the hex value when bit 3 is set Set all other bits to 0 Data payload 23 n U...

Page 122: ...address MSB 5 0x00 6 0x13 7 0xA2 8 0x00 9 0x01 10 0x23 11 0x84 LSB12 0x00 Reserved 13 0xFF 14 0xFE Source endpoint 15 0xE8 Destination endpoint 16 0xE8 Cluster ID 17 0x00 18 0x11 Profile ID 19 0xC1 2...

Page 123: ...bit 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 s...

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

Page 125: ...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 Invalid command 3 Invalid parameter Command data 8 n The register d...

Page 126: ...ntents 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 Netwo...

Page 127: ...elivered 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 coun...

Page 128: ...PI frames XBee XBee PRO DigiMesh 2 4 RF Module User Guide 128 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 0...

Page 129: ...out count 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 addr...

Page 130: ...LSB 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 MS...

Page 131: ...4 RF Module User Guide 131 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 0x...

Page 132: ...he frame 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 inform...

Page 133: ...DigiMesh 2 4 RF Module User Guide 133 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 0x...

Page 134: ...Description 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...

Page 135: ...e User Guide 135 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...

Page 136: ...sion 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 a...

Page 137: ...0x91 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 P...

Page 138: ...mask 18 Bitmask field that indicates which analog I O lines on the remote have sampling enabled if any Digital samples if included 19 20 If the sample set includes any digital I O lines Digital channe...

Page 139: ...2 0x14 Frame specific data 64 bit source address MSB 4 0x00 5 0x13 6 0xA2 7 0x00 8 0x40 9 0x52 10 0x2B LSB 11 0xAA Reserved MSB 12 0xfffe LSB 13 0x84 Receive options 14 0x01 Number of samples 15 0x01...

Page 140: ...sender s 64 bit address Reserved 12 13 Reserved Receive options 14 Bit field 0x01 Packet acknowledged 0x02 Packet was a broadcast packet 0x40 Point multipoint packet 0x80 Directed broadcast packet 0x...

Page 141: ...network receive the following node identification indicator A remote device with 64 bit address 0x0013A200407402AC and a default NI string sends a Node Identification all devices on the network receiv...

Page 142: ...16 0xFE 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 P...

Page 143: ...et Description 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...

Page 144: ...fset 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 1...

Page 145: ...Regulatory information United States FCC 146 Australia C Tick 153 Brazil ANATEL 153 Canada Industry Canada IC 154 Europe 154 Japan 156 XBee XBee PRO DigiMesh 2 4 RF Module User Guide 145...

Page 146: ...not expressly approved by Digi could void the user s authority to operate the equipment IMPORTANT OEMs must test final product to comply with unintentional radiators FCC section 15 107 and 15 109 befo...

Page 147: ...If a non professional performs the installation you must use non standard connectors RPSMA RPTNC and so forth The modules are FCC approved for fixed base station and mobile applications on channels 0x...

Page 148: ...ice is in operation The integrator may be responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radiofrequency Elec...

Page 149: ...M Yagi 16 element RPSMA connector 13 5 dBi Fixed 2 m 6 4 dB A24 Y18NF Yagi 18 element 15 0 dBi Fixed 2 m 7 9 dB Omni directional class antennas A24 F2NF Omni directional fiberglass base station 2 1 dB...

Page 150: ...e responsible for passing additional Specific Absorption Rate SAR testing based on FCC rules 2 1091 and FCC Guidelines for Human Exposure to Radio Frequency Electromagnetic Fields OET Bulletin and Sup...

Page 151: ...A24 Y9NF Yagi 9 element 10 0 dBi Fixed 2 m 12 1 dB A24 Y10NF Yagi 10 element 11 0 dBi Fixed 2 m 13 1 dB A24 Y12NF Yagi 12 element 12 0 dBi Fixed 2 m 14 1 dB A24 Y13NF Yagi 13 element 12 0 dBi Fixed 2...

Page 152: ...erglass base station 10 0 dBi Fixed 2 m 12 1 dB A24 F12NF Omni directional fiberglass base station 12 0 dBi Fixed 2 m 14 1 dB A24 F15NF Omni directional fiberglass base station 15 0 dBi Fixed 2 m 17 1...

Page 153: ...Australia All products with EMC and radio communications must have a registered C Tick mark Registration to use the compliance mark will only be accepted from Australian manufacturers or importers or...

Page 154: ...CES 003 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 Europe The...

Page 155: ...itials CE taking the following form n If the CE marking is reduced or enlarged the proportions given in the above graduated drawing must be respected n The CE marking must have a height of at least 5...

Page 156: ...of 14 dBm Any Omni directional type antenna with 14 dBi gain or less can be used with no cable loss Flat panel RF module was tested and approved with 19 dBi antenna gain with 4 8 dB cable loss EIRP M...

Page 157: ...Regulatory information Japan XBee XBee PRO DigiMesh 2 4 RF Module User Guide 157 R201WW07215214 XBee R201WW08215111 XBee PRO...

Search results

Summary of Contents for XBee DigiMesh 2.4

Reviews:

Related manuals for XBee DigiMesh 2.4

Brands by name

Popular brands

Digi XBee DigiMesh 2.4, User Manual

Search results

Summary of Contents for XBee DigiMesh 2.4

Reviews:

Related manuals for XBee DigiMesh 2.4

Brands by name

Popular brands