1. Manuals
  2. Brands
  3. Digi Manuals
  4. Control Unit
  5. XTend vB DigiMesh
  6. User manual

Digi XTend vB DigiMesh User Manual

Radio frequency (rf) module
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
XTend vB DigiMesh
Radio Frequency (RF) Module
User Guide

Advertisement

Table of Contents
loading

Related Manuals for Digi XTend vB DigiMesh

Summary of Contents for Digi XTend vB DigiMesh

  • Page 1 XTend vB DigiMesh Radio Frequency (RF) Module User Guide...
  • Page 2 Information 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, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
  • Page 3 To provide feedback on this document, email your comments to techcomm@digi.com Include the document title and part number (XTend vB DigiMesh RF Module User Guide, 90001479 B) in the subject line of your email. XTend vB DigiMesh RF Module User Guide...

  • Page 4: Table Of Contents

    Contents XTend vB DigiMesh RF Module User Guide Applicable firmware and hardware XTend replacement numbers Certification overview Development Kit Development Kit contents Interface hardware XTIB-R RS-232/485 Interface Board Configuration switch I/O and Power LEDs Serial port RSSI LEDs Power connector...
  • Page 5 NI (Node Identifier) NO (Network Discovery Options) NT (Network Discovery Back-off) SH (Serial Number High) SL (Serial Number Low) TO (Transmit Options) Command mode options CC (Command Character) CT (Command Mode Timeout) GT (Guard Times) XTend vB DigiMesh RF Module User Guide...
  • Page 6 AP (API Enable) BD (Baud Rate) FT (Flow Control Threshold) NB (Parity) RB (Packetization Threshold) RO (Packetization Timeout) SB (Stop Bits) Special commands AC (Apply Changes) CN (Exit Command Mode) FR (Software Reset) XTend vB DigiMesh RF Module User Guide...
  • Page 7 Apply changes on remote devices Remote command response Establish and maintain network links Build aggregate routes DigiMesh routing examples Replace nodes Test links in a network - loopback cluster Test links between adjacent devices Example RSSI indicators XTend vB DigiMesh RF Module User Guide...
  • Page 8 FCC notices RF exposure statement FCC antenna certifications XTend vB RF Module antenna options FCC publication 996369 related information ISED (Innovation, Science and Economic Development Canada) Labeling requirements Transmitters for detachable antennas Detachable antennas XTend vB DigiMesh RF Module User Guide...

  • Page 9: Xtend Vb Digimesh Rf Module User Guide

    XTend vB DigiMesh RF Module User Guide The XTend vB RF Module was engineered to provide customers with an easy-to-use radio frequency (RF) solution that provides reliable delivery of critical data between remote devices. The module transfers a standard asynchronous serial data stream, operates within the ISM 900 MHz frequency band and operates at an RF data rate of 125 kb/s.

  • Page 10: Applicable Firmware And Hardware

    XTend vB DigiMesh RF Module User Guide Applicable firmware and hardware Applicable firmware and hardware This manual supports the following firmware: 8xxx for XTend DigiMesh It supports the following hardware: As the name suggests, the XTend vB RF Module is form factor and over the air compatible with our XTend module.

  • Page 11: Development Kit

    Development Kit Development Kit contents Interface hardware XTIB-R RS-232/485 Interface Board Adapters Interface protocols XTend vB DigiMesh RF Module User Guide...

  • Page 12: Development Kit Contents

    Serial loopback Connects to the female RS-232 (DB-9) serial connector of the JD2D3- adapter Digi Interface Board and can be used to configure the device CDL-A to function as a repeater (for range testing) NULL modem Connects to the female RS-232 (DB-9) serial connector of the...

  • Page 13: Xtib-R Rs-232/485 Interface Board

    External DIP switch to automatically configure common device profiles. Signal conversion between TTL levels and RS-232 levels. The Digi Interface board can connect the device to any device that has an available RS-232, RS-485 or RS-422 connection. This documentation refers to a XTend vB RF Module mounted to an interface board as a "Module Assembly."...

  • Page 14: I/O And Power Leds

    Power connector 7-28 VDC power connector (center positive, 5.5/2.1 mm). The XTIB-R interface board can accept voltages as low as 5 V. Contact Digi Technical Support to enable this option. XTIB-R DIP switch The DIP switch automatically configures the device to operate in different modes during the power-on sequence.

  • Page 15: Adapters

    The development kit includes several adapters that facilitate the following functions: Performing range tests Testing cables Connecting to other RS-232 DCE and DTE devices Connecting to terminal blocks or RJ-45 (for RS-485/422 devices) XTend vB DigiMesh RF Module User Guide...

  • Page 16: Null Modem Adapter (Male-To-Male)

    Use the serial loopback adapter for range testing. During a range test, the serial loopback adapter causes the device to function as a repeater by looping serial data back into the device for retransmission. The following image shows the adapter and its pinouts. XTend vB DigiMesh RF Module User Guide...

  • Page 17: Male Db-9 To Rj-45 Adapter

    Part Number: JD3D3-CDN-A (Green) This adapter facilitates adapting the DB-9 Connector of the Interface Board to a CAT5 cable (female DB9 to female RJ45). For connection guidelines, see ‘RS-485 (4-wire) & RS-422 Operation’ sections. The following image shows the adapter and its pinouts. XTend vB DigiMesh RF Module User Guide...

  • Page 18: Interface Protocols

    (DB-9) serial connector. The Module Assembly reads and applies the DIP switch settings only during power-on. The following table provides the RS-232 signals and their implementations on the Module Assembly. Low-asserted signals have a horizontal line over the pin name. XTend vB DigiMesh RF Module User Guide...
  • Page 19 Optional power input that is connected internally to the Indicator positive lead of the front power connector RS-232 wiring diagrams The following diagram shows the DTE device (RS-232, male DB-9 connector) wired to a DCE Module Assembly (female DB-9). XTend vB DigiMesh RF Module User Guide...
  • Page 20 Development Kit Interface protocols The following diagram shows the DCE Module Assembly (female DB-9 connector) wired to a DCE device (RS-232, male DB-9). XTend vB DigiMesh RF Module User Guide...

  • Page 21: Rs-485 (2-Wire) Operation

    The following figure shows the RS-485 (2-wire) with termination (optional) DIP switch settings. Enabling termination activates a 120 Ω resistor between T+ and T-. The following figure shows the pins that the female RS-232 (DB-9) serial connector uses. XTend vB DigiMesh RF Module User Guide...
  • Page 22 Optional power input that is connected internally to the front power connector 1, 3, 4, 6, not used RS-485 wiring diagrams The following diagram shows the Module Assembly in an RS-485 (2-wire) half-duplex environment. XTend vB DigiMesh RF Module User Guide...

  • Page 23: Rs-485 (4-Wire) And Rs-422 Operation

    Serial data sent from the Module Assembly negative data line R- (RA) Receive Serial data received by the Module Assembly negative data line Signal ground Ground R+ (RB) Receive Serial data received by the Module Assembly positive data line XTend vB DigiMesh RF Module User Guide...
  • Page 24 RS-485/422 connection guidelines The RS-485/422 protocol provides a solution for wired communications that can tolerate high noise and push signals over long cable lengths. RS-485/422 signals can communicate as far as 4000 feet XTend vB DigiMesh RF Module User Guide...
  • Page 25 3. The connecting cable only requires 4 wires, even though there are 8 wires. 4. When using phone cabling (RJ-11), Pin 2 in the cable maps to Pin 3 on the opposite end of cable and Pin 1 maps to Pin 4 respectively. XTend vB DigiMesh RF Module User Guide...

  • Page 26: Technical Specifications

    WARNING! When operating at 1 W power output, observe a minimum separation distance of 6 ft (2 m) between devices. Transmitting in close proximity of other devices can damage the device's front end. General specifications Performance specifications Networking specifications Power requirements Regulatory conformity summary XTend vB DigiMesh RF Module User Guide...

  • Page 27: General Specifications

    Up to 500 feet (150 m) Receiver sensitivity 125 kb/s -100 dBm UART data rate (software selectable)  1200 - 230400 baud Networking specifications The following table provides the networking specifications for the device. XTend vB DigiMesh RF Module User Guide...

  • Page 28: Power Requirements

    Transmit current (3.3 V, typical) 340 mA 615 mA Regulatory conformity summary This table describes the agency approvals for the devices. Nation Approval United States Contains FCC ID: MCQ-XBPSX Canada Contains IC: 1846A-XBPSX XTend vB DigiMesh RF Module User Guide...

  • Page 29: Hardware

    Hardware Connect the hardware Mechanical drawings Pin signals XTend vB DigiMesh RF Module User Guide...

  • Page 30: Connect The Hardware

    The following figure shows the XTend vB RF Module and accessories you need to get started and how to connect them. The accessories are in the XT09-DK development kit. Item Description Antenna, RPSMA (female) XTend vB module, RPSMA version shown DIP switches 9 V power supply DB9 serial cable XTend vB DigiMesh RF Module User Guide...

  • Page 31: Mechanical Drawings

    The following drawing shows the location of the pins. When integrating the module with a Host PC board, leave all lines that you do not use disconnected (floating). High impedance during Must number Name shutdown connect Function Ground XTend vB DigiMesh RF Module User Guide...
  • Page 32 (to the UART host). For more information, see . SHDN Shutdown: Drive this pin high to enable normal operation and low during Shutdown. Shutdown enables the lowest power mode available to the module. Reserved XTend vB DigiMesh RF Module User Guide...
  • Page 33 For more information, see RP (RSSI PWM Timer). 12 - 20 Reserved / do not connect The RF module has a 10 kΩ internal pull-up resistor. The RF module has a 10 kΩ internal pull-up resistor. XTend vB DigiMesh RF Module User Guide...

  • Page 34: Modes

    Transmit mode (Serial data in the serial receive buffer is ready to be packetized) Sleep mode Command Mode (Command mode sequence is issued (not available when using the SPI port)) Transparent and API operating modes Receive mode Transmit mode Command mode XTend vB DigiMesh RF Module User Guide...

  • Page 35: Transparent And Api Operating Modes

    If a destination node receives a valid RF packet, the destination node transfers the data to its serial transmit buffer. For the serial interface to report received data on the RF network, that data must meet the following criteria: Network ID match Channel match Address match XTend vB DigiMesh RF Module User Guide...

  • Page 36: Transmit Mode

    Command mode successfully and is ready to start processing AT commands. If configured to operate in Transparent operating mode, when entering Command mode the XTend vB RF Module knows to stop sending data and start accepting commands locally. XTend vB DigiMesh RF Module User Guide...

  • Page 37: Troubleshooting

    AC (Apply Changes). Parameter format Refer to the list of AT commands for the format of individual AT command parameters. Valid formats for hexidecimal values include with or without a leading 0x for example FFFF or 0xFFFF. XTend vB DigiMesh RF Module User Guide...

  • Page 38: Response To At Commands

    (Command Mode Timeout), it returns to Transparent or API mode. The default Command mode timeout is 10 seconds. For an example of programming the device using AT Commands and descriptions of each configurable parameter, see Commands. XTend vB DigiMesh RF Module User Guide...

  • Page 39: Operation

    WARNING! When operating at 1 W power output, observe a minimum separation distance of 6 ft (2 m) between devices. Transmitting in close proximity of other devices can damage the device's front end. Serial interface UART data flow Serial data Flow control XTend vB DigiMesh RF Module User Guide...

  • Page 40: Serial Interface

    RTS flow control lets the host signal the device so it will not send the data in the serial transmit buffer out the UART. The following diagram shows the internal data flow, with the five most common pin signals. XTend vB DigiMesh RF Module User Guide...

  • Page 41: Data In (Din) Buffer And Flow Control

    DIN pin (pin 5) in the DIN buffer. It transmits the data in the DIN buffer over-the-air when the device no longer detects RF data in the network. XTend vB DigiMesh RF Module User Guide...

  • Page 42: Data Out (Do) Buffer And Flow Control

    If you enable RTS for flow control (RT = 2), data will not be sent out the DO Buffer as long as RTS (pin 16) is de-asserted. Software flow control (XOFF) You can enable XON/XOFF software flow control using FL (Software Flow Control). This option only works with ASCII data. XTend vB DigiMesh RF Module User Guide...
  • Page 43 Networking methods The MAC and PHY layers 64-bit addresses Make a unicast transmission Delivery methods XTend vB DigiMesh RF Module User Guide...

  • Page 44: Networking Methods

    We assign each device a unique IEEE 64-bit address at the factory. When a device is in API operating mode and it sends a packet, this is the source address that the receiving device returns. XTend vB DigiMesh RF Module User Guide...

  • Page 45: Make A Unicast Transmission

    Make a unicast transmission Use the SH and SL commands to read this address. The form of the address is: 0x0013A2XXXXXXXXXX. The first six digits are the Digi Organizationally Unique Identifier (OUI). The broadcast address is 0x000000000000FFFF. Make a unicast transmission To transmit to a specific device in Transparent operating mode: Set DH:DL to the SH:SL of the destination device.

  • Page 46: Digimesh Networking

    Selective acknowledgments. Only the destination node will reply to route requests. Reliable delivery. Reliable delivery of data is accomplished by means of acknowledgments. Sleep modes. Low power sleep modes with synchronized wake are supported with variable sleep and wake times. XTend vB DigiMesh RF Module User Guide...
  • Page 47 The firmware uses an associative routing table to map a destination node address with its next hop. A device sends a message to the next hop address, and the message either reaches its destination or forwards to an intermediate router that routes the message on to its destination. XTend vB DigiMesh RF Module User Guide...
  • Page 48 It represents the amount of time it takes to send a unicast transmission between two adjacent nodes. The amount of time depends on the %H parameter. XTend vB DigiMesh RF Module User Guide...
  • Page 49 After it fails, it initiates route discovery and, when the route discovery finishes, transmits the data along the new route. You can estimate the timeout associated with the entire operation as follows: brokenRouteUnicastTime=BroadcastTxTime+(NH*unicastOneHopTime)+ (2*knownRouteUnicastTime) XTend vB DigiMesh RF Module User Guide...

  • Page 50: At Commands

    AT commands Addressing commands Command mode options Diagnostic commands Firmware commands I/O settings commands I/O diagnostic commands MAC/PHY commands Network commands Security commands Serial interfacing commands Special commands XTend vB DigiMesh RF Module User Guide...

  • Page 51: Addressing Commands

    0 - 0xFFFFFFFF Default 0xFFFF NI (Node Identifier) Stores the node identifier string for a device, which is a user-defined name or description of the device. This can be up to 20 ASCII characters. XTend vB DigiMesh RF Module User Guide...

  • Page 52: Network Discovery Options)

    Parameter range 0x0 - 0x7 (bit field) Bit field Option Description Append the DD (Digi Device Identifier) value to ND responses or API node identification 0x01 frames. Local device sends ND response frame out the serial interface when ND is issued.

  • Page 53: Sh (Serial Number High)

    Enable a Trace Route on all DigiMesh API packets NACK Enable a NACK messages on all DigiMesh API packets Disable RD Disable Route Discovery on all DigiMesh unicasts Disable ACK Disable acknowledgments on all unicasts XTend vB DigiMesh RF Module User Guide...

  • Page 54: Command Mode Options

    Set the required period of silence before 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 (one second) XTend vB DigiMesh RF Module User Guide...

  • Page 55: Diagnostic Commands

    The number of RF bytes transmitted. The firmware counts 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 from 0xFFFF. XTend vB DigiMesh RF Module User Guide...

  • Page 56: Db (Last Packet Rssi)

    (the value does not persist in the device's memory after a power-up sequence). Occasionally random noise can cause this value to increment. The ER parameter is not reset by pin, serial port or cyclic sleep modes. XTend vB DigiMesh RF Module User Guide...

  • Page 57: Gd (Good Packets Received)

    [read-only]: 40 - 110 [dBm] Default R# (Reset Number) Provides the reason for the last device reset. Parameter range Parameter Description Power up reset Watchdog reset Software reset Reset line reset Brownout reset Default XTend vB DigiMesh RF Module User Guide...

  • Page 58: Tr (Transmission Failure Count)

    After a firmware update this command may return a different value. Parameter range Default DD (Device Type Identifier) Stores the Digi device type identifier value. Use this value to differentiate between multiple XBee devices. If you change DD, RE (Restore Defaults) will not restore defaults.

  • Page 59: Np (Maximum Packet Payload Bytes)

    Set in firmware VR (Firmware Version) Reads the firmware version on a device. Parameter range 0 - 0xFFFFFFFF [read-only] Default Set in firmware I/O settings commands The following AT commands are I/O settings commands. XTend vB DigiMesh RF Module User Guide...

  • Page 60: Cd (Gp02 Configuration)

    The following table shows dB levels above sensitivity and PWM values. The total time period of the PWM output is 8.32 ms. PWM output consists of 40 steps, so the minimum step size is 0.208 ms. XTend vB DigiMesh RF Module User Guide...

  • Page 61: Rt (Gpi1 Configuration)

    The following AT commands are I/O diagnostic commands. TP (Board Temperature) The current module temperature in degrees Celsius in 8-bit two’s compliment format. For example 0x1A = 26 °C, and 0xF6 = -10 °C. XTend vB DigiMesh RF Module User Guide...

  • Page 62: Mac/Phy Commands

    0 - 0x0F and 0x8000 - 0xFFFF (factory-set) Default 0x3332 MT (Broadcast Multi-Transmits) Set or read the number of additional MAC-level broadcast transmissions. All broadcast packets are transmitted MT+1 times to ensure they are received. Parameter range Default XTend vB DigiMesh RF Module User Guide...

  • Page 63: Tx Power Level)

    The following commands are network commands. BH (Broadcast Hops) The maximum transmission hops for broadcast data transmissions. If you set BH greater than NH, the device uses the value of NH. Parameter range 0 - 0x20 Default XTend vB DigiMesh RF Module User Guide...

  • Page 64: Ce (Routing / Messaging Mode)

    You can use this parameter to calculate the maximum network traversal time. You must set this parameter to the same value on all nodes in the network. Parameter range 1 - 20 hops Default XTend vB DigiMesh RF Module User Guide...

  • Page 65: Nn (Network Delay Slots)

    This command is write-only. If you attempt to read KY, the device returns an OK status. Set this command parameter the same on all devices in a network. Parameter range 128-bit value Default Serial interfacing commands The following AT commands are serial interfacing commands. XTend vB DigiMesh RF Module User Guide...

  • Page 66: Ao (Api Options)

    To request non-standard baud rates with values above 0x80, you can use the Serial Console toolbar in XCTU to configure the serial connection (if the console is connected), or click the Connect button (if the console is not yet connected). XTend vB DigiMesh RF Module User Guide...

  • Page 67: Ft (Flow Control Threshold)

    CTS when less than FT - 16 bytes are in the UART receive buffer. Parameter range 0x11 - 0x16F Default 0x13F NB (Parity) Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x04 XTend vB DigiMesh RF Module User Guide...

  • Page 68: Rb (Packetization Threshold)

    100-200 µsec of additional uncertainty, which could be significant for small values of RO at high UART bit rates. The firmware calculates the correct UART character time (10, 11, or 12 bits) based on the following criteria: XTend vB DigiMesh RF Module User Guide...

  • Page 69: Sb (Stop Bits)

    The following commands are special commands. AC (Apply Changes) Immediately applies new settings without exiting Command mode. Parameter range Default CN (Exit Command Mode) Immediately exits Command Mode and applies pending changes. Parameter range Default XTend vB DigiMesh RF Module User Guide...

  • Page 70: Software Reset)

    Once you issue a WR command, do not send any additional characters to the device until after you receive the OK response. Parameter range Default R1 (Restored Compiled) Restore device parameters to the compiled defaults. Parameter range Default XTend vB DigiMesh RF Module User Guide...

  • Page 71: Operate In Api Mode

    Operate in API mode API mode overview XTend vB DigiMesh RF Module User Guide...

  • Page 72: Api Mode Overview

    Set API to 2 to allow escaped control characters in the API frame. Due to its increased complexity, we only recommend this API mode in specific circumstances. API 2 may help improve reliability if the serial interface to the device is unstable or malformed frames are frequently being generated. XTend vB DigiMesh RF Module User Guide...
  • Page 73 Frame data This field contains the information that a device receives or will transmit. The structure of frame data depends on the purpose of the API frame: XTend vB DigiMesh RF Module User Guide...

  • Page 74: Calculate And Verify Checksums

    Consider the following sample data packet: 7E 00 0A 01 01 50 01 00 48 65 6C 6C 6F B8+ Byte(s) Description Start delimiter 00 0A Length bytes API identifier API frame ID 50 01 Destination address low Option byte XTend vB DigiMesh RF Module User Guide...

  • Page 75: Escaped Characters In Api Frames

    2. Append it with the byte you want to escape, XOR'ed with 0x20. In API mode with escaped characters, the length field does not include any escape characters in the frame and the firmware calculates the checksum with non-escaped data. XTend vB DigiMesh RF Module User Guide...
  • Page 76 Aggregate Addressing Update frame - 0x8E Legacy RX Indicator frame - 0x80 RX Indicator frame - 0x90 Explicit Rx Indicator frame - 0x91 Node Identification Indicator frame - 0x95 Remote Command Response frame - 0x97 XTend vB DigiMesh RF Module User Guide...

  • Page 77: Api Frame Exchanges

    Transmit Status frame indicates the cause of failure. Use the AP command to choose the type of data frame you want to receive, either a (0x90) RX Indicator frame or a (0x91) Explicit Rx Indicator frame. XTend vB DigiMesh RF Module User Guide...

  • Page 78: Remote At Commands

    API frames that are sent out the device's DOUT pin: void XBee_HandleRxAPIFrame(_apiFrameUnion *papiFrame){ switch(papiFrame->api_id){ case RX_RF_DATA_FRAME: //process received RF data frame break; case RX_IO_SAMPLE_FRAME: //process IO sample frame break; case NODE_IDENTIFICATION_FRAME: //process node identification frame break; XTend vB DigiMesh RF Module User Guide...
  • Page 79 API frames Code to support future API frames default: //Discard any other API frame types that are not being used break; XTend vB DigiMesh RF Module User Guide...

  • Page 80: At Command Frame - 0X08

    The following example illustrates an AT Command frame when you query the device's NH parameter value. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x04 Frame type 0x08 Frame ID 0x52 XTend vB DigiMesh RF Module User Guide...
  • Page 81 API frames AT Command frame - 0x08 Frame data fields Offset Example AT command 0x4E (N) 0x48 (H) Parameter value (NH2 = two network hops) 0x02 Checksum 0x0D XTend vB DigiMesh RF Module User Guide...

  • Page 82: At Command - Queue Parameter Value Frame - 0X09

    In this example, you could send the parameter as a zero-padded 2-byte or 4-byte value. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x05 Frame type 0x09 XTend vB DigiMesh RF Module User Guide...
  • Page 83 API frames AT Command - Queue Parameter Value frame - 0x09 Frame data fields Offset Example Frame ID 0x01 AT command 0x42 (B) 0x44 (D) Parameter value (BD7 = 115200 baud) 0x07 Checksum 0x68 XTend vB DigiMesh RF Module User Guide...

  • Page 84: Legacy Tx Request Frame - 0X00

    Description This frame causes the device to send payload data as an RF packet. This packet format is deprecated and should only be used by customers who require compatibility with legacy Digi RF products. We encourage you to use Transmit Request frame - 0x10 to initiate API transmissions.
  • Page 85 Legacy TX Request frame - 0x00 Frame data fields Offset Example Destination address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0xC5 LSB 12 0x07 Options 0x00 RF data 0x54 0x78 0x44 0x61 0x74 0x61 Checksum 0xA5 XTend vB DigiMesh RF Module User Guide...

  • Page 86: Transmit Request Frame - 0X10

    See the following Transmit Options table. Set all other bits to 0. options RF data Up to NP bytes per packet. Sent to the destination device. 17-n Transmit Options bit field Bit field: XTend vB DigiMesh RF Module User Guide...
  • Page 87 Frame type 0x10 Frame ID 0x01 64-bit destination MSB 5 0x00 address 0x13 0xA2 0x00 0x40 0x0A 0x01 LSB 12 0x27 16-bit destination 0xFF MSB 13 network address 0xFE LSB 14 Broadcast radius 0x00 XTend vB DigiMesh RF Module User Guide...
  • Page 88 0x00 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 0x7D 0x33 The device calculates the checksum (on all non-escaped bytes) as [0xFF - (sum of all bytes from API frame type through data payload)]. XTend vB DigiMesh RF Module User Guide...

  • Page 89: Explicit Addressing Command Frame - 0X11

    If set to 0, the transmission radius set to the network maximum hops value. If the broadcast radius exceeds the value of NH then the devices use the value of NH as the radius. Only broadcast transmissions use this parameter. XTend vB DigiMesh RF Module User Guide...
  • Page 90 64-bit address: 0x0013A200 01238400 Source endpoint: 0xE8 Destination endpoint: 0xE8 Cluster ID: 0x11 Profile ID: 0xC105 Payload: TxData Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x1A Frame type 0x11 XTend vB DigiMesh RF Module User Guide...
  • Page 91 Reserved 0xFF 0xFE Source endpoint 0xE8 Destination endpoint 0xE8 Cluster ID 0x00 0x11 Profile ID 0xC1 0x05 Broadcast radius 0x00 Transmit options 0x00 Data payload 0x54 0x78 0x44 0x61 0x74 0x61 Checksum 0xA6 XTend vB DigiMesh RF Module User Guide...

  • Page 92: Remote At Command Request Frame - 0X17

    Change the broadcast hops register on a remote device to 1 (broadcasts go to 1-hop neighbors only). Apply changes so the new configuration value takes effect immediately. In this example, the 64-bit address of the remote device is 0x0013A200 40401122. XTend vB DigiMesh RF Module User Guide...
  • Page 93 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x40 0x11 LSB 12 0x22 Reserved 0xFF 0xFE Remote command options 0x02 (apply changes) AT command 0x42 (B) 0x48 (H) Command parameter 0x01 Checksum 0xF5 XTend vB DigiMesh RF Module User Guide...

  • Page 94: At Command Response Frame - 0X88

    If you change the BD parameter on a local device with a frame ID of 0x01, and the parameter is valid, the user receives the following response. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x05 Frame type 0x88 Frame ID 0x01 XTend vB DigiMesh RF Module User Guide...
  • Page 95 AT Command Response frame - 0x88 Frame data fields Offset Example AT command 0x42 (B) 0x44 (D) Command status 0x00 Command data (No command data implies the parameter was set rather than queried) Checksum 0xF0 XTend vB DigiMesh RF Module User Guide...

  • Page 96: Modem Status Frame - 0X8A

    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 LSB 2 0x02 Frame type 0x8A Status 0x00 Checksum 0x75 XTend vB DigiMesh RF Module User Guide...

  • Page 97: Transmit Status Frame - 0X8B

    Example In the following example, the destination device reports a successful unicast data transmission successful and a route discovery occurred. The outgoing Transmit Request that this response frame uses Frame ID of 0x47. XTend vB DigiMesh RF Module User Guide...
  • Page 98 Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x07 Frame type 0x8B Frame ID 0x47 Reserved 0xFF 0xFE Transmit retry count 0x00 Delivery status 0x00 Discovery status 0x02 Checksum 0x2E XTend vB DigiMesh RF Module User Guide...

  • Page 99: Legacy Tx Status Frame - 0X89

    The following example shows a successful status received. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x03 Frame type 0x89 Frame ID 0x01 Status 0x00 Checksum 0x75 XTend vB DigiMesh RF Module User Guide...

  • Page 100: Route Information Packet Frame - 0X8D

    The following example represents a possible Route Information Packet. A device receives the packet when it performs a trace route on a transmission from one device (serial number 0x0013A200 4052AAAA) to another (serial number 0x0013A200 4052DDDD). XTend vB DigiMesh RF Module User Guide...
  • Page 101 Timestamp MSB 6 0x9C 0x93 0x81 LSB 9 0x7F ACK timeout count 0x00 TX blocked count 0x00 Reserved 0x00 Destination address MSB 13 0x00 0x13 0xA2 0x00 0x40 0x52 0xAA LSB 20 0xAA XTend vB DigiMesh RF Module User Guide...
  • Page 102 0x52 0xDD LSB 28 0xDD Responder address MSB 29 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 36 0xBB Receiver address MSB 37 0x00 0x13 0xA2 0x00 0x40 0x52 0xCC LSB 44 0xCC XTend vB DigiMesh RF Module User Guide...

  • Page 103: Aggregate Addressing Update Frame - 0X8E

    In the following example, a device with destination address (DH/DL) of 0x0013A200 4052AAAA updates its destination address to 0x0013A200 4052BBBB. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x12 Frame type 0x8E Format ID 0x00 XTend vB DigiMesh RF Module User Guide...
  • Page 104 Aggregate Addressing Update frame - 0x8E Frame data fields Offset Example New address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 12 0xBB Old address 0x00 0x13 0xA2 0x00 0x40 0x52 0xAA 0xAA Checksum 0x19 XTend vB DigiMesh RF Module User Guide...

  • Page 105: Legacy Rx Indicator Frame - 0X80

    In the following example, a device with a 64-bit address of 0x0013A200 4052C507 sends a unicast data transmission to a remote device with payload RxData. If AO = 2 on the receiving device, it sends the following frame out its serial interface. XTend vB DigiMesh RF Module User Guide...
  • Page 106 0x11 Frame type 0x80 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x52 0xC5 LSB 11 0x07 RSSI 0x28 Options 0x01 0x52 Received data 0x78 0x44 0x61 0x74 0x61 Checksum 0xFF XTend vB DigiMesh RF Module User Guide...

  • Page 107: Rx Indicator Frame - 0X90

    RxData. If AO=0 on the receiving device, it sends the following frame out its serial interface. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x12 0x90 Frame type XTend vB DigiMesh RF Module User Guide...
  • Page 108 Offset Example MSB 4 0x00 64-bit source address 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Receive options 0x01 Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x11 XTend vB DigiMesh RF Module User Guide...

  • Page 109: Explicit Rx Indicator Frame - 0X91

    If a device sends the transmission: With source and destination endpoints of 0xE0 Cluster ID = 0x2211 Profile ID = 0xC105 If AO = 1 on the receiving device, it sends the following frame out its serial interface. XTend vB DigiMesh RF Module User Guide...
  • Page 110 LSB 11 0xAA Reserved 0xFF 0xFE Source endpoint 0xE0 Destination endpoint 0xE0 Cluster ID 0x22 0x11 Profile ID 0xC1 0x05 Receive options 0x02 Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x68 XTend vB DigiMesh RF Module User Guide...

  • Page 111: Node Identification Indicator Frame - 0X95

    NO (Network Discovery Options). Source event 1 = Frame sent by node identification pushbutton event. Digi Profile ID 31-32 Set to the Digi application profile ID. Digi 33-34 Set to the Digi Manufacturer ID. Manufacturer XTend vB DigiMesh RF Module User Guide...
  • Page 112 MSB 1 0x00 Length LSB 2 0x25 Frame type 0x95 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x74 0x02 LSB 11 0xAC Reserved 0xFF 0xFE Receive options 0xC2 Reserved 0xFF 0xFE XTend vB DigiMesh RF Module User Guide...
  • Page 113 0x00 Reserved 0xFF 0xFE Device type 0x01 Source event 0x01 Digi Profile ID 0xC1 0x05 Digi Manufacturer ID 0x10 0x1E Digi DD value 0x00 (optional) 0x0C 0x00 0x00 RSSI (optional) 0x2E Checksum 0x33 XTend vB DigiMesh RF Module User Guide...

  • Page 114: Remote Command Response Frame - 0X97

    SL command, and if the frame ID = 0x55, the response would look like the following example. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x13 Frame type 0x97 Frame ID 0x55 XTend vB DigiMesh RF Module User Guide...
  • Page 115 LSB 12 0xAA Reserved 0xFF 0xFE 16-bit source (remote) address MSB 13 0x7D LSB 14 0x84 AT commands 0x53 (S) 0x4C (L) Command status 0x00 Command data 0x40 0x52 0x2B 0xAA Checksum 0xF4 XTend vB DigiMesh RF Module User Guide...
  • Page 116 Work with networked devices Network commissioning and diagnostics Local configuration Remote configuration Establish and maintain network links Test links in a network - loopback cluster Test links between adjacent devices XTend vB DigiMesh RF Module User Guide...

  • Page 117: Work With Networked Devices

    When the local device receives a remote command response transmission, it sends a remote command response API frame out its UART. The remote command response indicates: XTend vB DigiMesh RF Module User Guide...

  • Page 118: Establish And Maintain Network Links

    All the nodes in the network that receive the AG broadcast set their DH to 0x0013A200 and their DL to 0x4052C507. These nodes automatically build a route to the aggregator node. XTend vB DigiMesh RF Module User Guide...

  • Page 119: Replace Nodes

    The following figure demonstrates how you can use the Loopback cluster ID and data endpoint to measure the link quality in a mesh network. XTend vB DigiMesh RF Module User Guide...

  • Page 120: Test Links Between Adjacent Devices

    5. When device B completes transmitting the test link packets, it sends the following data packet to device A's Test Link Result Cluster (0x0094) on endpoint (0xE6). 6. Device A outputs the following information as an API Explicit RX Indicator (0x91) frame: XTend vB DigiMesh RF Module User Guide...

  • Page 121: Example

    B and send the results back to device C to be output. It is also possible for device B to request device A to perform the previously mentioned test. In other words, the XTend vB DigiMesh RF Module User Guide...

  • Page 122: Rssi Indicators

    You can send FN locally on a device in Command mode or you can use a local AT Command frame - 0x08. To use FN remotely, send the target node a Remote AT Command Request frame - 0x17 using FN as the name of the AT command. XTend vB DigiMesh RF Module User Guide...

  • Page 123: Trace Route Option

    There is no guarantee that Route Information Packet frames will arrive in the same order as the route taken by the unicast packet. On a weak route, it is also possible for the transmission of Route Information Packet frames to fail before arriving at the unicast originator. XTend vB DigiMesh RF Module User Guide...

  • Page 124: Nack Messages

    Route Information Packet (0x8D) frame and sends it to the originator of the unicast. This information is useful because it allows you to identify and repair marginal links. XTend vB DigiMesh RF Module User Guide...

  • Page 125: Regulatory Information

    Regulatory information FCC (United States) ISED (Innovation, Science and Economic Development Canada) XTend vB DigiMesh RF Module User Guide...

  • Page 126: Fcc (United States)

    These RF modules comply with Part 15 of the FCC rules and regulations. Compliance with the labeling requirements, FCC notices and antenna usage guidelines is required. In order to operate under Digi’s FCC Certification, integrators must comply with the following regulations: 1.

  • Page 127: Rf Exposure Statement

    Section 15.247 (emissions). Fixed base station and mobile applications Digi devices are pre-FCC 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.

  • Page 128: Xtend Vb Rf Module Antenna Options

    Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas. Dipole antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number...
  • Page 129 9.0 dB Fixed/mobile A09-Y14TM* 14 element Yagi 14.0 dBi RPTNC 9.9 dB Fixed/mobile Omni-directional base station antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
  • Page 130 Part number Type Gain Connector Required antenna cable loss Application A09-F0NF* Fiberglass base station 0 dBi Fixed A09-F1NF* Fiberglass base station 1.0  dBi Fixed A09-F2NF-M Fiberglass base station 2.1 dBi Fixed A09-F3NF* Fiberglass base station 3.1 dBi Fixed A09-F4NF* Fiberglass base station 4.1 dBi Fixed A09-F5NF-M...
  • Page 131 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 antenna manufacturer for an equivalent option. Part number Type Gain Connector Required antenna cable loss...
  • Page 132 Part number Type Gain Connector Required antenna cable loss Application A09-QRAMM 3" Quarter wave wire 2.1 dBi MMCX Fixed/mobile A09-QRSM-2.1* Quarter wave 2.1" right angle 3.3 dBi RPSMA 0.4 dB Fixed/mobile A09-QW* Quarter wave wire 1.9 dBi Permanent Fixed/mobile A09-QSM-3* Quarter wave straight 1.9 dBi RPSMA...

  • Page 133: Fcc Publication 996369 Related Information

    FCC grant which includes significant extra testing and cost. If an embedded trace or chip antenna is desired, contact a Digi sales representative for information on how to engage with a lab to get the modified FCC grant.
  • Page 134 XTend vB DigiMesh module was tested to be complaint to FCC unintentional radiator standards, FCC Part 15 Subpart B compliance testing is still required for the final host product. This testing is required for all end products, and XTend vB DigiMesh module Part 15 Subpart B compliance does not affirm the end product’s compliance.

  • Page 135: Ised (Innovation, Science And Economic Development Canada)

    Dans le but de réduire les risques de brouillage radioélectrique à l'intention des autres utilisateurs, il faut choisir le type d'antenne et son gain de sorte que la puissance isotrope rayonnée équivalente (p.i.r.e.) ne dépasse pas l'intensité nécessaire àl'établissement d'une communication satisfaisante. XTend vB DigiMesh RF Module User Guide...

This manual is also suitable for:

Xt09-miXt09-siXt09-mi-meshXt09-si-mesh

Table of Contents